Commit 5e122d1

committed

docs: Add to docs/README.md

1 parent a1bc2d3 commit 5e122d1Copy full SHA for 5e122d1

File tree

+31

-2

lines changed

+31

-2

lines changed

Lines changed: 31 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -63,11 +63,40 @@ $ cd docs`
`63`	`63`	`### Create base structure`
`64`	`64`
`65`	`65`	```bash
`66`		`-$ cp index.html README.md <PATH_TO_YOUR_REPO>/docs`
	`66`	`+$ cp index.html<PATH_TO_YOUR_REPO>/docs`
`67`	`67`	`$ cd <PATH_TO_YOUR_REPO>/docs`
`68`		`-$ touch .nojekyll _coverpage.md _sidebar_.md`
	`68`	`+$ touch README.md .nojekyll _coverpage.md _sidebar_.md`
`69`	`69`	```
`70`	`70`
	`71`	+You can leave the `.nojekyll` untouched as it just helps Github Pages include the underscore files in builds.
	`72`	`+`
	`73`	`+### Configure README.md`
	`74`	`+`
	`75`	+The `docs/README.md` file is your homepage. It might have a structure like this:
	`76`	`+`
	`77`	+```
	`78`	`+# Project name`
	`79`	`+> Project description`
	`80`	`+`
	`81`	`+## Sample`
	`82`	`+`
	`83`	`+...`
	`84`	`+`
	`85`	`+## Installation`
	`86`	`+`
	`87`	`+...`
	`88`	`+`
	`89`	`+## Usage`
	`90`	`+`
	`91`	`+...`
	`92`	+```
	`93`	`+`
	`94`	+You can have no links and very short _README.md_ file and it will work fine. With _Docsify_. we rely on the sidebar menu to provide links to your files in `docs`.
	`95`	`+`
	`96`	+But you can optionally put links in that file to your other docs files, if that makes sense in your _README.md_. (They must be relative to docs directory such as `file.md`, not absolute URLs such as with `/docs/file.md`)
	`97`	`+`
	`98`	`+You may want to copy or move content from your root _README.md_ to the _docs/REAME.md_ file.`
	`99`	`+`
`71`	`100`	`### Configure index page`
`72`	`101`
`73`	`102`	`You can leave the _index.html_ page as it is.`

Comments

(0)