Skip to content

Commit 22e9aed

Browse files
committed
docs: Update README.md
1 parent 2760cb5 commit 22e9aed

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
1-
# docsify-template
2-
Run a docs site for your project by adding docsify-js and minimal config, but without updating existing docs or build static pages
1+
# Docsify Template
2+
> Live demo of a light docs site built on _docsify-js_ and running on Github Pages
3+
4+
Convert your docs folder into a pretty docs website using _docsify_ and some minimal setup. This project can be used as a template or reference for your own.
5+
6+
See the [Docsify](https://docsify.js.org/) website.
7+
8+
9+
## How it works
10+
11+
Note that this works without editing your existing docs and without building any HTML page.
12+
13+
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.
14+
15+
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.
16+
17+
## Setup
18+
19+
### Overview steps
20+
21+
1. Add a few files to your existing docs folder. You can use this project's files to get you going.
22+
- Add an _index.html_ file. This will setup the app using the _docsify_ library, set a theme and apply other configurations.
23+
- Add file describing your menu layout, as _docsify_ is not aware of directory structure.
24+
2. Turn your Github repo into a Github pages site which builds from the docs directory.
25+
26+
### Detailed Steps
27+
28+
29+
You can optionally use the command-line tool to
30+
- Setup an initial _README.md_ and _index.html_ in your docs directory.
31+
- Serve the docs site locally, with hot reload.
32+
33+
34+
## License
35+
36+
MIT License - [LICENSE](/LICENSE).

0 commit comments

Comments
 (0)