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

Skip to content

Commit 4ea4d11

Browse files
Update README.md
1 parent 058aa23 commit 4ea4d11

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
_This repo is my most starred and most forked repo - thanks for supporting._
2222

23-
The [Docsify](https://docsify.js.org/#/) site has great quickstart, but I found that it did not guide me through what to do next. And all the config options and plugins were overwhelming and I probably won't need most of them, at least for a while. So I created this as a tutorial to guide you through setting up a site, whether new to or experienced with DocsifyJS.
23+
The [Docsify](https://docsify.js.org/#/) site has great quickstart for beginners, but with all the configs and plugin options available if feels more like a dictionary than a recipe for setting up a custom docs site which is not code heavy. So I created this tutorial to take beginners and advanced users through setting up Docsify in ordered steps - noting as well when steps are optional or what the choices are.
2424

2525
This tutorial takes you from basic site setup and content to optional configuration of styling, menus and plugins. It aims to cover common use-cases in a logical sequence, rather than covering everything you could do. You can also jump to a later step if you want to use that as a reference.
2626

@@ -46,11 +46,11 @@ Some background on how I arrived at DocsifyJS as a docs site builder.
4646

4747
My aims for building a docs site are:
4848

49-
- add as little code and configuration as possible
50-
- make it easy to maintain
51-
- quick to get setup on existing projects
52-
- have no layout files
53-
- reduce dependencies
49+
- Add as little code and configuration as possible
50+
- Make it easy to maintain
51+
- Quick to get setup on existing projects
52+
- Have no layout files
53+
- Reduce dependencies
5454

5555
The docs site tool used here is [DocsifyJS](https://docsify.js.org/) which is a frontend JS library written in VueJS. But if you have never used before or never coded in JS before, you'll be guided through. The only JS you need to write in your config values. You also need to edit some HTML values and possibly write a YAML file for your navbar, which again is more configuration than code.
5656

0 commit comments

Comments
 (0)