GitHub - hdytsgt/docsify: 🃏 A magical documentation site generator.

A magical documentation site generator.

Features

Simple and lightweight (~12kb gzipped)
Multiple themes
Not build static html files

Quick start

Create a index.html and using hash router.

index.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify" data-router></script>
</html>

CDN

UNPKG https://unpkg.com/docsify/
jsDelivr http://www.jsdelivr.com/projects/docsify

Showcase

These open-source projects are using docsify to generate their sites. Pull requests welcome : )

docsify - A magical documentation site generator.
Snipaste - A new way to boost your productivity.
puck - A small & magical php framework.

Similar projects

docute - 📜 Effortlessly documentation done right
docpress - Documentation website generator

Contributing

Fork it!
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

prepare

npm i && npm run dev
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.

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

MIT

Links