Skip to content

Commit 6351bbf

Browse files
docs: Update README.md
1 parent 96a716b commit 6351bbf

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Docsify Template
2-
> How to build a docs site with _Docsify-JS_ and _Github Pages_.
2+
> Tutorial on how to build a docs site with _Docsify-JS_ and _Github Pages_, including an easy quickstart template
33
44
[![Made with Docsify](https://img.shields.io/badge/Made%20with-Docsify-blue.svg)](https://docsify.js.org/)
55
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-template.svg)](https://GitHub.com/MichaelCurrin/docsify-template/tags/)
66
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-template/blob/master/LICENSE)
77

8-
Convert your docs folder into a pretty docs website using [Docsify-JS](https://docsify.js.org/) and some minimal setup instructions. This project's doc site itself running on _Docsify_.
8+
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.
99

10-
This project aims to use easy instructions for newcomers to Docsify and also includes as little effort as possible to get the quickstart / template project copied into your own project.
10+
## Project aims
1111

12-
## Tutorial
12+
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.
13+
14+
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).
15+
16+
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.
17+
18+
_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.
19+
20+
## Follow the tutorial
1321

1422
The tutorial is available in two forms:
1523

0 commit comments

Comments
 (0)