Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 377e86a

Browse files
Update README.md
1 parent e3bd77f commit 377e86a

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

β€Ždocs/README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ I like that once I have the HTML set up that Incan focus on markdown content and
7373

7474
When you use _Docsify_ with its defaults or very simple tweaks, you get a pretty UI with menus, themes, mobile functionality and a cover page. Page loads are seamless in the app shell, as it is a SPA. These are things that take more effort and code changes or additions, if you want to do them with static-site generators. _Docsify_ also had documentation as its main purpose, unlike some other tools.
7575

76-
There are some downsides like Docsify does not have static site support yet (which makes it weak for SEO rankings) and there are only 4 themes, which are just color scheme changes. And the dark one doesn't have good contrast for certain things.
76+
There are some downsides like _Docsify_ does not have static site support yet (which makes it weak for SEO rankings) and there are only 4 themes, which are just color scheme changes. And the dark one doesn't have good contrast for certain things.
7777

7878
![icon](_media/docs_brackets.png)
7979

80-
This great [article](https://dev.to/evilmartians/keeping-oss-documentation-with-docsify-lefthook-and-friends-11e5) on dev.to covers a journey from README to Wiki to Jekyll and finally Docsify, if you are interested to compare those.
80+
This great [article](https://dev.to/evilmartians/keeping-oss-documentation-with-docsify-lefthook-and-friends-11e5) on dev.to covers a journey from README to Wiki to Jekyll and finally _Docsify_, if you are interested to compare those.
8181

8282

8383
## Resources
@@ -185,11 +185,11 @@ If you switch to history [Router Mode](#router-mode), this won't matter.
185185

186186
It's best to avoid using HTML tags with hyperlinks and rather use Markdown where possible.
187187

188-
HTML tag hyperlinks will be rendered literally and so will **break** in the Docsify path structure e.g. `href="foo.md"` is bad but `[](foo.md)` is good.
188+
HTML tag hyperlinks will be rendered literally and so will **break** in the _Docsify_ path structure e.g. `href="foo.md"` is bad. But `[](foo.md)` is good.
189189

190190
You can set them up manually, which makes them harder to maintain if your site structure changes. e.g. `href="/#/id=my-project"` or `href="/#/foo.md?id=my-project"`.
191191

192-
Also note that the root prefix is needed for Docsify paths to work, but you'll also need to hard-code your repo name in which is fragile too. e.g. `href="/my-repo/#/id=my-project"`
192+
Also note that the root prefix is needed for _Docsify_ paths to work, but you'll also need to hard-code your repo name in which is fragile too. e.g. `href="/my-repo/#/id=my-project"`
193193

194194

195195
## Quickstart local server
@@ -588,16 +588,15 @@ Load and configure this plugin to add the `Edit on GitHub` link in the top right
588588
- [njleonzhang/docsify-edit-on-github](https://github.com/njleonzhang/docsify-edit-on-github) on GitHub.
589589

590590

591-
Load this plugin near the end of the `head` tag.
592-
593-
!> **Important:** This will **not** work at the end of the body like most plugins, since the plugin's global variable needs be available when the app is configured.
591+
Load this plugin inside the `head` tag.
594592

595593
```html
596594
<script src="//unpkg.com/docsify-edit-on-github/index.js"></script>
597595
```
598596

599-
Configure the plugin - see below.
597+
Then your configuration set up inthe `body` tag will using a vlue set by the script.
600598

599+
Configure the plugin in the `body`. See below.
601600

602601
**Basic usage**
603602

@@ -620,15 +619,15 @@ Arguments:
620619
```
621620
- Example based on this repo:
622621
```javascript
623-
var docBase = 'https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/docs/';
622+
const docBase = 'https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/docs/';
624623
625624
EditOnGitHubPlugin.create(docBase);
626625
```
627626

628627
Full example:
629628

630629
```javascript
631-
var repo = 'https://github.com/MichaelCurrin/docsify-js-tutorial';
630+
const repo = 'https://github.com/MichaelCurrin/docsify-js-tutorial';
632631
633632
window.$docsify = {
634633
name: 'DocsifyJS Tutorial',
@@ -744,10 +743,10 @@ You can embed content such as video, audio, iframes (`.html`), code blocks or ev
744743
745744
#### Embed format
746745
747-
Add the `':include'` parameter in a markdown URL reference. Here is the format:
746+
Add the `":include"` parameter in a markdown URL reference. Here is the format:
748747
749748
```markdown
750-
[filename](url ':include')
749+
[filename](url ":include")
751750
```
752751
753752
The URL could be a local file (e.g. `_media/foo.js`) or a remote URL `https://...`.
@@ -890,10 +889,9 @@ See resources:
890889

891890
Follow the instructions in [Quickstart local server](#quickstart-local-server).
892891

892+
### Docsfiy subcommands
893893

894-
### Commands
895-
896-
#### `docsify init`
894+
#### init subcommand
897895

898896
> Creates new docs
899897

@@ -905,7 +903,7 @@ e.g.
905903
$ docsify init docs
906904
```
907905

908-
#### `docsify serve`
906+
#### serve subcommand
909907

910908
> Run local server to preview site.
911909

@@ -925,7 +923,7 @@ Serves at [localhost:3000/](http://localhost:3000/), or a different port if ther
925923

926924
This uses is the main use for Docsify - an `index.html` page is served, the JS is loaded on the frontend and then markdown pages are requested and converted to HTML as needed. It is a **Single-Page Application**, so will work great from a user perspective but will score low on search engines. Even though the SEO crawlers can handle JavaScript, there is limited "crawl budget" for a JavaScript-based SPA so this means less of your site is crawled or your site is rated poorly. Constrast with the option below.
927925

928-
#### `docsify start`
926+
#### start subcommand
929927

930928
> Server for SSR
931929

0 commit comments

Comments
(0)

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /