add showcase and edit Development Tips (#47)
This commit is contained in:
parent
4e7485aa1f
commit
9ce47c48af
1 changed files with 20 additions and 0 deletions
20
README.md
20
README.md
|
|
@ -51,6 +51,7 @@ These open-source projects are using docsify to generate their sites. Pull reque
|
||||||
|
|
||||||
- [docsify](https://docsify.js.org) - A magical documentation site generator.
|
- [docsify](https://docsify.js.org) - A magical documentation site generator.
|
||||||
- [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.
|
- [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.
|
||||||
|
- [puck](https://puck.zz173.com/) - A small & magical php framework.
|
||||||
|
|
||||||
## Similar projects
|
## Similar projects
|
||||||
- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
|
- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
|
||||||
|
|
@ -67,11 +68,30 @@ These open-source projects are using docsify to generate their sites. Pull reque
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
### prepare
|
||||||
```shell
|
```shell
|
||||||
npm i && npm run dev
|
npm i && npm run dev
|
||||||
open http://localhost:3000
|
open http://localhost:3000
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### MoreLanguageHighlight
|
||||||
|
|
||||||
|
By default,docsify will only highlight faw language ,such as `html`,`css`,`javascript` eg.
|
||||||
|
if u want to add more ,like php. just edit `src/render.js` ,and then add a language import.
|
||||||
|
|
||||||
|
```javacript
|
||||||
|
import marked from 'marked'
|
||||||
|
import Prism from 'prismjs'
|
||||||
|
//this line ↓
|
||||||
|
import prism_php from 'prismjs/components/prism-php'
|
||||||
|
// or
|
||||||
|
import prism_ruby from 'prismjs/components/prism-ruby'
|
||||||
|
// and so on...
|
||||||
|
import prism_markdown from 'prismjs/components/prism-markdown'
|
||||||
|
import * as tpl from './tpl'
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
MIT
|
MIT
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue