From feb4b894613271a698dabe37fda071d76a412989 Mon Sep 17 00:00:00 2001 From: Jintzo Date: Tue, 21 Feb 2017 07:04:16 +0100 Subject: [PATCH 001/686] Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar --- README.md | 13 +++++++------ docs/README.md | 8 ++++---- docs/_coverpage.md | 2 +- docs/_sidebar.md | 6 +++--- docs/cover.md | 26 +++++++++++++------------- docs/custom-navbar.md | 27 ++++++++++++++++----------- docs/more-pages.md | 24 ++++++++++++++---------- docs/quickstart.md | 34 ++++++++++++++++++---------------- 8 files changed, 76 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index da243a4..d9ae89d 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,8 @@ - [CLI](https://github.com/QingWei-Li/docsify-cli) ## Features -- Not build static html files + +- No statically built html files - Simple and lightweight (~14kB gzipped) - Smart full-text search plugin - Multiple themes @@ -29,9 +30,9 @@ ## Quick start Create a `index.html`. -index.html - ```html + + @@ -47,10 +48,10 @@ index.html ## Browser Support -Modern browsers and Internet Explorer 9+. +Modern browsers and Internet Explorer 10+. ## Showcase -These open-source projects are using docsify to generate their sites. Pull requests welcome : ) +These open-source projects are using docsify to generate their sites. Pull requests welcome :blush: - [Snipaste](https://docs.snipaste.com/) - Snip & Paste - [puck](https://puck.zz173.com/) - A small & magical php framework. @@ -69,7 +70,7 @@ These open-source projects are using docsify to generate their sites. Pull reque - Create your feature branch: `git checkout -b my-new-feature` - Commit your changes: `git commit -am 'Add some feature'` - Push to the branch: `git push origin my-new-feature` -- Submit a pull request :D +- Submit a pull request ## Development diff --git a/docs/README.md b/docs/README.md index 51f2506..203b496 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,13 +4,13 @@ ## What is it -docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. It smartly loads and parses your Markdown files and displays them in website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy). +docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy). See the [Quick start](/quickstart) for more details. ## Features -- Not build static html files +- No statically built html files - Simple and lightweight (~14kB gzipped) - Smart full-text search plugin - Multiple themes @@ -19,9 +19,9 @@ See the [Quick start](/quickstart) for more details. ## Examples -Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to see use the docsify generated website. +Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use. ## Donate -If you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart: +Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart: diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 45bc9f6..050d427 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -5,7 +5,7 @@ > A magical documentation site generator. - Simple and lightweight (~14kB gzipped) -- Not build static html files +- No statically built html files - Multiple themes diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 3753426..7e666dc 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -9,12 +9,12 @@ - [Themes](/themes) - [Using plugins](/plugins) - [Markdown configuration](/markdown) - - [Lanuage highlight](/language-highlight) + - [Lanuage highlighting](/language-highlight) - Guide - [Deploy](/deploy) - - [Doc helper](/helpers) - - [Compatible Vue](/vue) + - [Helpers](/helpers) + - [Vue compatibility](/vue) - [CDN](/cdn) - [Changelog](/changelog) \ No newline at end of file diff --git a/docs/cover.md b/docs/cover.md index 2a538e7..e633e8f 100644 --- a/docs/cover.md +++ b/docs/cover.md @@ -1,15 +1,14 @@ # Cover -Activate the cover feature by setting `coverpage`. The detail in [Configuration#coverpage](configuration#coverpage). +Activate the cover feature by setting `coverpage` to **true**. Details are available in the [coverpage configuration paragraph](configuration#coverpage). ## Basic usage -Set `coverpage` to **true**, and create a `_coverpage.md`. You can see the effect in current website. - - -*index.html* +Set `coverpage` to **true**, and create a `_coverpage.md`: ```html + + ``` -*_coverpage.md* ```markdown + + ![logo](_media/icon.svg) -# docsify +# docsify 3.0 > A magical documentation site generator. -- Simple and lightweight (~12kb gzipped) +- Simple and lightweight (~14kB gzipped) +- No statically built html files - Multiple themes -- Not build static html files [GitHub](https://github.com/QingWei-Li/docsify/) -[Get Started](#quick-start) +[Get Started](#docsify) ``` !> A document site can have only one cover page. ## Custom background -The background color is generated randomly by default. You can customize the background color or image. - -*_coverpage.md* +The background color is generated randomly by default. You can customize the background color or image: ```markdown + + # docsify [GitHub](https://github.com/QingWei-Li/docsify/) diff --git a/docs/custom-navbar.md b/docs/custom-navbar.md index cc78741..fabbb3c 100644 --- a/docs/custom-navbar.md +++ b/docs/custom-navbar.md @@ -1,10 +1,12 @@ # Custom navbar -You can create navbar in HTML file. But note that the link begins with `#/`. +## HTML -*index.html* +If you need custom navigation, you can create a HTML-based navigation bar (but note that documentation links begin with `#/`). ```html + +