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

Skip to content

Commit 6a0641e

Browse files
MichaelCurrinMichaelCurrin
authored
Update README.md
1 parent 57d16fb commit 6a0641e

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

‎docs/README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,28 @@
55
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial.svg)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
66
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#license)
77

8-
Convert your _docs_ folder into a pretty docs website using [DocsifyJS](https://docsify.js.org/) and some minimal setup instructions. This project's site itself is also running on _DocsifyJS_.
8+
Convert your **docs** folder into a pretty docs website - using [DocsifyJS](https://docsify.js.org/) and some minimal setup instructions. This project's site itself is also running on _DocsifyJS_. :tada:
99

1010
?> _DocsifyJS_ is sometimes just called _Docsify_ in this guide. Also known as _Docsify.js_.
1111

1212

13-
## Resource links
13+
## Resources
14+
> Docs and Docsify-related links
1415
1516
### My projects
1617

1718
- [DocsifyJS Tutorial](https://github.com/michaelcurrin/docsify-js-tutorial/) repo on Github.
1819
- [DocsifyJS Template](https://michaelcurrin.github.io/docsify-js-template/) project.
19-
- [MkDocs Quickstart](https://michaelcurrin.github.io/mkdocs-quickstart/) project - as an alternative to Docsify, try this demo / tutorial / template around MkDocs.
20+
- [MkDocs Quickstart](https://michaelcurrin.github.io/mkdocs-quickstart/) project
21+
- As an alternative to Docsify, try this demo / tutorial / template around MkDocs.
2022

21-
### Github repos
23+
### Official Docsify repos
2224

23-
- Docsify - [docsifyjs/docsify](https://github.com/docsifyjs/docsify)
24-
- Docsify CLI - [docsifyjs/docsify-cli](https://github.com/docsifyjs/docsify-cli)
25+
- Docsify main repo - [docsifyjs/docsify](https://github.com/docsifyjs/docsify)
26+
- Docsify CLI repo - [docsifyjs/docsify-cli](https://github.com/docsifyjs/docsify-cli)
2527

2628

27-
## Purpose
29+
## Purpose of this tutorial
2830

2931
This project is for you if you answer yes to any of the following:
3032

@@ -39,13 +41,13 @@ This project is for you if you answer yes to any of the following:
3941

4042
This project provides three approaches for choosing a Docsify site to run:
4143

42-
- [Quickstart local server](#quickstart-local-server)
44+
- Use the [Quickstart local server](#quickstart-local-server)
4345
- Clone this repo and start serving the docs repo immediately.
44-
- [Setup your own docs site](#setup-your-own-docs-site)
46+
- [Setup your own docs site](#setup-your-own-docs-site) from scratch
4547
- Convert your _docs_ directory into a docs site hosted on Github Pages. Copy from some templates files to get up and running with as little effort as possible.
46-
- [DocsifyJS Template](https://github.com/michaelcurrin/docsify-js-template/) repo
48+
- Use my [DocsifyJS Template](https://github.com/michaelcurrin/docsify-js-template/) repo
4749
- A minimal template which goes with this tutorial.
48-
- Click _Use this template_ there and you'll be able to starting serving a site on Github Pages or locally.
50+
- Click [Use this template](https://img.shields.io/badge/Use_this_template-green.svg?style=for-the-badge) to add a copy to you own repos. you'll be able to starting serving a site on Github Pages or locally.
4951

5052
_Note: The instructions in this repo are intended for Linux and macOS environments._
5153

@@ -241,6 +243,8 @@ Example:
241243

242244
[\_sidebar.md](https://raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/nested_example/_sidebar.md ':include :type=code')
243245

246+
?> The sidebar is a markdown file, so you can styling as a `**Title**`.
247+
244248
##### Setup custom sidebar
245249

246250
1. Ensure `loadSidebar: true` is set in the _index.html_ file.
@@ -515,14 +519,13 @@ Plugin | Description
515519
[Tabs](https://docsify.js.org/#/plugins?id=tabs) | A Docsify.js plugin for displaying tabbed content from markdown.
516520

517521
Also of interest:
522+
518523
- For pulling in JSON data and not just markdown files:
519524
- [bandorko/docsify-variables](https://github.com/bandorko/docsify-variables)
520525
- [kissybnts/docsify-json-variables](https://github.com/kissybnts/docsify-json-variables) or on [npm](https://www.npmjs.com/package/docsify-json-variables)
521-
522-
The DocsifyJS site covers long lists of plugins and how to use them:
523-
524-
- [List of Plugins](https://docsify.js.org/#/plugins?id=list-of-plugins)
525-
- [Awesome plugins](https://docsify.js.org/#/awesome?id=plugins)
526+
- The DocsifyJS site covers long lists of plugins and how to use them:
527+
- [List of Plugins](https://docsify.js.org/#/plugins?id=list-of-plugins)
528+
- [Awesome plugins](https://docsify.js.org/#/awesome?id=plugins)
526529

527530

528531
##### Use the Edit on Github plugin
@@ -532,15 +535,15 @@ Load and configure this plugin to add the `Edit on Github` link in the top right
532535
- [njleonzhang/docsify-edit-on-github](https://github.com/njleonzhang/docsify-edit-on-github) on Github.
533536

534537

535-
Load this plugin near the end of the `head` tag.
538+
Load this plugin near the end of the `head` tag.
539+
540+
!> **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.
536541
537542
```javascript
538543
<script src="//unpkg.com/docsify-edit-on-github/index.js"></script>
539544
```
540545
541-
!> **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.
542-
543-
Configure the plugin.
546+
Configure the plugin - see below.
544547
545548
546549
**Basic usage**
@@ -617,7 +620,6 @@ Arguments:
617620
```
618621
619622
620-
621623
## Setup Github Pages site
622624
623625
If you followed the steps above, you'll have a locally running docs site.
@@ -628,7 +630,7 @@ Next, edit your repo's setting on Github. Select the option to serve the `docs`
628630
629631
Open the link in the browser.
630632
631-
- http://localhost:3000
633+
- [localhost:3000](http://localhost:3000)
632634
633635
To make the most of Docsify, update your content using the next section.
634636
@@ -695,12 +697,12 @@ Render markdown as code snippet. Use the `type` parameter.
695697
Code:
696698
697699
```markdown
698-
[_sidebar.md](_coverpage.md ':include :type=code')
700+
[\_sidebar.md](_coverpage.md ':include :type=code')
699701
```
700702
701703
Result:
702704
703-
[_sidebar.md](_coverpage.md ':include :type=code')
705+
[\_sidebar.md](_coverpage.md ':include :type=code')
704706
705707
706708
##### Markdown as rendered HTML

0 commit comments

Comments
 (0)