Skip to content

Commit 5d6b78a

Browse files
committed
docs: Update docs/README.md
1 parent c5b322a commit 5d6b78a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Demo site: [link](https://michaelcurrin.github.io/docsify-template/#/).
55

66
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup. This project can be used as a template or reference for your own.
77

8+
My own aim is to turn the docs of many of my existing projects into doc sites with minimal effort to convert them and maintain them.
89

910
## Basics to get a site working
1011

@@ -83,12 +84,15 @@ More on Docsify [themes](https://docsify.js.org/#/themes?id=themes) guide.
8384
View the Docsify [Quickstart](https://docsify.js.org/#/quickstart) guide for instructions on setting up the CLI tool and running a site.
8485

8586
The CLI tool is optional and is useful for the following:
87+
8688
- Setup an initial _README.md_ (duplicated from project root), _index.html_ and _.nojekyll_ in your a target directory such as _docs_. You can do this by hand or using a template if you don't want the CLI to do it for you.
8789
- Serve the docs site locally, with hot reload.
8890

8991

9092
## Why not a static site generator?
9193

92-
If you were using a static site generator like Jekyll, you might have to add front matter to your docs, in addition to setting Jekyll config for theme and menu layout.
94+
Jekyll and Hugo are options for static site generators which can use themes suited to documentation and they can build off of a docs directory. If you want to read more about those, see my [resources](https://github.com/MichaelCurrin/static-sites-generator-resources) project.
95+
96+
A static site generator can be heavy - managing dependencies, building HTML, theming. You might have to add front matter to your doc files. You have to set your menu structure in a similar way to _Docsify_.
9397

9498
Also, with a static site generator you would build HTML files to serve, while with Docsify there is a single page application running off of a _index.html_ - on each request, a markdown file is fetched by the client and rendered as HTML with a theme and menu.

0 commit comments

Comments
 (0)