diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c821acf4..00e7cc969 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## 1.3.0 +### Features + +- Add cover page + +### Bug fixes +- sidebar highlight +- headling can be cliked +- add `` style + ## 1.2.0 ### Features - custom basePath diff --git a/README.md b/README.md index ce4d4e289..bceee7b87 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

Travis Status npm - npm + code style

## Links @@ -19,14 +19,14 @@ - [CLI](https://github.com/QingWei-Li/docsify-cli) ## Features -- Easy and lightweight (~12kb gzipped) -- Custom themes -- No build +- Simple and lightweight (~12kb gzipped) +- Multiple themes +- Not build static html files ## Quick start -Create a `404.html` and `README.md` into `/docs`. +Create a `index.html` and using `hash router`. -404.html +index.html ```html @@ -38,26 +38,14 @@ Create a `404.html` and `README.md` into `/docs`.
- + ``` -Or Create a `index.html` and using `hash router`. - -index.html +Or create a `404.html` and `README.md` into `/docs`. Just remove `data-router` ```html - - - - - - - -
- - - + ``` ## CDN @@ -70,11 +58,21 @@ These open-source projects are using docsify to generate their sites. Pull reque - [docsify](https://docsify.js.org) - A magical documentation site generator. - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity. -## How to contribute +## Contributing - Fork it! -- Run `npm i && npm run dev` -- open `localhost:3000` +- 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 + + +## Development + +```shell +npm i && npm run dev +open http://localhost:3000 +``` ## License MIT diff --git a/docs/README.md b/docs/README.md index 83f861782..8e293e50f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,16 +1,3 @@ -

- docsify -

- -

- A magical documentation site generator. -

- -## Features -- Easy and lightweight (~12kb gzipped) -- Custom themes -- No build - ## Quick Start ### Create a project @@ -107,6 +94,28 @@ Code in `404.html` - UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/) - jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify) + +### Cover Page + +Through the markdown can generate a cover page. create a `_coverpage.md` and set `data-coverpage` in script tag. + +```markdown +![logo](_media/icon.svg) + +# docsify 1.2.0 + +> A magical documentation site generator. + +- Simple and lightweight (~12kb gzipped) +- Multiple themes +- Not build static html files + + +[GitHub](https://github.com/QingWei-Li/docsify/) +[Get Started](#quick-start) +``` + + ### Options #### repo @@ -242,7 +251,7 @@ Scroll to the top on changing hash. #### homepage -`README.md` will be render as homepage for your website in docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo. we can use: +`README.md` will be render as homepage for your website in docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo. we can use (need `data-router`): ```html @@ -261,3 +270,14 @@ If your HTML entry file and the markdown files are in different directories, we ``` + + +#### coverpage + +Generate cover page. + +```html + + + +``` \ No newline at end of file diff --git a/docs/_coverpage.md b/docs/_coverpage.md new file mode 100644 index 000000000..ba8b87a6f --- /dev/null +++ b/docs/_coverpage.md @@ -0,0 +1,13 @@ +![logo](_media/icon.svg) + +# docsify 1.3.0 + +> A magical documentation site generator. + +- Simple and lightweight (~12kb gzipped) +- Multiple themes +- Not build static html files + + +[GitHub](https://github.com/QingWei-Li/docsify/) +[Get Started](#quick-start) diff --git a/docs/_media/icon.svg b/docs/_media/icon.svg new file mode 100644 index 000000000..7f125e6da --- /dev/null +++ b/docs/_media/icon.svg @@ -0,0 +1,30 @@ + + + + icon + Created with Sketch. + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 0b0a13b1f..da425007c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,7 +6,7 @@ - +