Skip to content

Commit 54764c2

Browse files
committed
docs: Update docs
1 parent 6a0b1b3 commit 54764c2

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

docs/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Docsify JS Tutorial
1+
# Docsify JS Tutorial homepage
22
> How to build a docs site using _Docsify-JS_ and _Github Pages_
33
44
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
@@ -31,7 +31,9 @@ You can use _Docsify_ with its defaults or very simple tweaks, yet get a UI with
3131

3232
## _Docsify_ basics
3333

34-
A _Docsify_ doc site works works _without_ the need to edit your existing docs and _without_ building any HTML pages. The rendering is done on the client-side in a single page application, running on _index.html_.
34+
An intro to _Docsify_.
35+
36+
A _Docsify_ site works works _without_ the need to edit your existing docs and _without_ building any HTML pages. The rendering is done on the client-side in a single page application, running on _index.html_.
3537

3638
### Structure
3739

docs/_coverpage.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
# Docsify JS Tutorial
44
> Tutorial to turn your docs into a docs site using base files
55
6-
- :hourglass_flowing_sand: Setup a basic site in a few minutes
7-
- :open_file_folder: No need to reformat or restructure existing markdown docs
8-
- :pushpin: No static site generator needed
9-
- :hammer: No CLI tool required - library loads in the browser
6+
- :hourglass_flowing_sand: Setup an elegant, responsive, fast site in a few minutes
7+
- :open_file_folder: - Content comes from markdown files in your _docs_ directory - no templating syntax to learn
8+
- :pushpin: No compiling needed and no templating syntax to learn
9+
- :hammer:Easy to configure
1010
- :nut_and_bolt: Built on [Docsify-JS](https://docsify.js.org/)
11-
- :pizza: Serve locally or on Github Pages
11+
- :pushpin: No local dependencies - library loads in the browser
12+
- :pizza: Serve locally or on Github Pages / Netlify
1213

1314
[GitHub](https://github.com/michaelcurrin/docsify-js-tutorial/)
14-
[Getting Started](#docsify-js-tutorial)
15+
[Use a template](https://github.com/michaelcurrin/docsify-js-template/)
16+
[Getting Started](#docsify-js-tutorial-homepage)

0 commit comments

Comments
 (0)