Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ce73b67

Browse files
Update README.md
1 parent 4e8f683 commit ce73b67

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -488,21 +488,22 @@ Arguments:
488488
- `docBase`
489489
- Required.
490490
- It should be a full path to your doc's site directory on Github.
491-
- Here is the general form.
491+
- Here is the general form - use your own repo details and typically `BRANCH` is `master` and `DIRECTORY` is `docs`.
492492
```
493493
https://github.com/USERNAME/REPONAME/blob/BRANCH/DIRECTORY/'
494494
```
495-
- Example based on this repo, where the docs site is in the `docs` directory.
495+
- Example based on this repo:
496496
```javascript
497497
var docBase = 'https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/docs/';
498+
498499
EditOnGithubPlugin.create(docBase);
499500
```
500501
- `docEditBase`
501-
- Optional.
502-
- It defaults to the first argument if not set.
502+
- Optional - defaults to the first argument if not set.
503503
- `title`
504-
- Optional.
505-
- Set if you want to override the text. Example:
504+
- Optional - defaults to `'Edit on Github`.
505+
- Set to override the message.
506+
- Example:
506507
```javascript
507508
EditOnGithubPlugin.create(
508509
repo,

0 commit comments

Comments
 (0)