Skip to content

Commit 6a0b1b3

Browse files
committed
docs: Update README.md files
1 parent d5b4326 commit 6a0b1b3

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ The repo is open for accepting contributions through a Pull Request.
5252

5353
## License
5454

55-
[MIT license](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
55+
Licensed under [MIT license](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/LICENSE)
5656

57-
Modify and reuse this project. Please link back to this repo.
57+
- You can modify and reuse this project.
58+
- A copy of the license and copyright notice must be included with the software. [source](https://choosealicense.com/licenses/#mit).
59+
- Please link back to this repo somewhere in your project.

docs/README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,25 @@
55
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial.svg)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
66
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#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 is also running on _Docsify_.
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 site itself is also running on _Docsify_.
99

10-
If you know what _Docsify_ is and want to start using it immediately, feel free to skip to one of these sections:
10+
## Start a Docsify site
1111

12-
- [Quickstart local server](#quickstart-local-server) - Get a demo site running.
13-
- [Setup your own docs site](#setup-your-own-docs-site) - Convert your docs directory into a docs site hosted on Github pages. Uses templates files to get up and running with as little effort as possible.
12+
This project provides three options for a choosing a docs site to run:
13+
14+
- [Quickstart local server](#quickstart-local-server)
15+
- Clone this repo and start serving the docs repo.
16+
- [Setup your own docs site](#setup-your-own-docs-site)
17+
- Convert your _docs_ directory into a docs site hosted on Github Pages. Copy from some templates files to get up and running with as little effort as possible.
18+
- [Docsify JS Template](https://github.com/michaelcurrin/docsify-js-template/) repo
19+
- A minimal template which was moved out of this project into a separate repo.
20+
- Click _Use this template_ there and you'll be able to starting serving a site on Github Pages or locally.
1421

1522
_Note: The instructions in this repo are intended for Linux and macOS environments._
1623

1724
## Why use _Docsify_?
1825

19-
My requirement is to build a docs site with minimal setup to use existing docs directories without restructuring or formatting the docs. I found _Docsify_ is ideal for this.
26+
My requirement was to build a docs site with minimal setup to use existing docs directories without restructuring or formatting the docs. I found _Docsify_ is ideal for this.
2027

2128
You can use _Docsify_ with its defaults or very simple tweaks, yet get a UI with menus, themes, mobile functionality and a cover page. And page loads are seamless in the shell as it is a SPA. These things that take more effort and code changes or additions if you want to do them with static-site generators. _Docsify_ also documentation as its main purpose, unlike some other tools.
2229

@@ -28,7 +35,7 @@ A _Docsify_ doc site works works _without_ the need to edit your existing docs a
2835

2936
### Structure
3037

31-
Main components of a _Docsify_ site.
38+
Main components of a _Docsify_ site:
3239

3340
- **cover page** - Optional. Landing page with background color or image and some minimal text.
3441
- **homepage** - First page that a user sees, after the cover page. This is a content page written in markdown and it could be the only page of your site if you like.
@@ -67,17 +74,17 @@ Start running a local server to preview a _Docsify_ site. Choose an option below
6774

6875
- Run [Docsify CLI](#docsify-cli) web server.
6976
```bash
70-
$ # From project root.
77+
$ # From project root, serve docs directory.
7178
$ docsify serve docs
72-
$ # Shortcut.
79+
$ # Shortcut provided by Makefile.
7380
$ make docs
7481
```
7582
- Run a Python web server.
7683
```bash
7784
$ cd docs
7885
$ python3 -m http.server 3000
7986
```
80-
- Choose something else from this big list - [link](https://gist.github.com/willurd/5720255).
87+
- Choose another server option from this large list - [link](https://gist.github.com/willurd/5720255).
8188

8289
## Quickstart local server
8390

0 commit comments

Comments
 (0)