You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project will guide you to convert your project's docs folder into a pretty docs website. This project's own docs site is built on _Docsify-JS_ so serves as a good example.
12
+
This project will guide you on how to convert your project's docs folder into a pretty and elegant docs website. This project's own docs site is built on _Docsify-JS_ so serves as a good example.
13
13
14
14
15
15
## π― Project aims
16
16
17
-
The idea is to add as little code as possible, to make it easy to maintain and quick to get going. The tool used here is [Docsify-JS](https://docsify.js.org/) but no prior knowledge is needed, so this is ideal for newcomers.
17
+
The idea is to:
18
18
19
-
The tutorial covers the basics and provides minimal setup instructions. You can add the quickstart project to your **existing** docs folder. If you doc files are markdown files, you don't have to rename them and their formatting can mostly stay the same (links may need updating).
19
+
- add as little code and configuration as possible
20
+
- make it easy to maintain
21
+
- quick to get setup on existing projects
22
+
- have no layout files
23
+
- reduce dependencies
20
24
21
-
Unlike static site builders like Jekyll or Hugo, you do not need to install or run a site generator or change the formatting or metadata of your markdown files. Your also don't need any config files - the configuration is handled in the _index.html_ page, which is also where dependencies are fetched in the browser and where the app starts.
25
+
The docs site tool used here is [Docsify-JS](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.
22
26
23
-
_Docsify_ works as a single-page application on this one page - data from your markdown files is pulled in and displayed within the _Docsify_ UI shell. There are no template layout files to manage.
27
+
This project's tutorial covers the basics and provides minimal setup instructions. You can add the quickstart project to your **existing** docs folder. If you doc files are markdown files, you don't have to rename them and their formatting can mostly stay the same i.e. no frontmatter or special syntax and the pages still render well as plain markdown even. But some links may need updating since `/docs` folder is now the root of the app.
28
+
29
+
Unlike static site builders like Jekyll or Hugo, you do **not** need to install or run a site generator or change the formatting or metadata of your markdown files. Your also don't need any separate config file - the configuration is handled in the _index.html_ page, which is also where dependencies are fetched in the browser and where the app starts.
30
+
31
+
_Docsify_ works as a single-page application on this one page - data from your markdown files is pulled in and displayed within the _Docsify_ UI shell. There are no template layout files to manage and you can choose from some themes easily without things breaking like when you switch themes in other static site generators.
@@ -30,6 +38,11 @@ The tutorial is available in two forms:
30
38
- Github Pages: [docs site](https://michaelcurrin.github.io/docsify-template/#/). This also live demo of the kind of site you would have after completing the tutorial.
31
39
- Project docs: View the docs as plain markdown format in the repo, either locally or on Github. See the [docs](/docs) directory.
32
40
33
-
The tutorial references the [quickstart](/quickstart) directory at the project root.
41
+
The tutorial references the [quickstart](/quickstart) directory at the project root, in case you want to see that.
34
42
35
43
See also the [Nested Example](/nested_example/README.md) section for understanding links in markdown and the sidebar.
44
+
45
+
46
+
## Contributing
47
+
48
+
The repo is open for accepting contributions through a Pull Request.
0 commit comments