## Links
+
+- [`develop` branch preview](https://docsifyjs.netlify.com/)
- [Documentation](https://docsify.js.org)
-- [CLI](https://github.com/QingWei-Li/docsify-cli)
+- [CLI](https://github.com/docsifyjs/docsify-cli)
+- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
+- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
+- [Community chat](https://gitter.im/docsifyjs/Lobby)
## Features
-- Not build static html files
-- Simple and lightweight (~14kB gzipped)
+
+- No statically built html files
+- Simple and lightweight (~21kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
-- Compatible with IE10+
+- Compatible with IE11
+- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
+- Support embedded files
## Quick start
-Create a `index.html`.
-index.html
+Look at [this tutorial](https://docsify.js.org/#/quickstart)
-```html
-
-
-
-
-
-
-
-
-
-
-
-```
-
-## Browser Support
-
-Modern browsers and Internet Explorer 9+.
+[](https://codesandbox.io/s/307qqv236)
## Showcase
-These open-source projects are using docsify to generate their sites. Pull requests welcome : )
-- [Snipaste](https://docs.snipaste.com/) - Snip & Paste
-- [puck](https://puck.zz173.com/) - A small & magical php framework.
-- [Samaritan](http://samaritan.stockdb.org) - An Algorithmic Trading Framework for Digital Currency.
-- [Vudash](http://vudash.github.io/vudash/) - Powerful, Flexible, Open Source dashboards for anything
-- [Trilogy](http://trilogy.js.org) - No-hassle SQLite with a Promise-based, document store style API.
-- [Mybatis-Plus](http://mp.baomidou.com/) - An enhanced toolkit of Mybatis to simplify development
+These projects are using docsify to generate their sites. Pull requests welcome :blush:
+
+Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
## Similar projects
-- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
-- [docpress](https://github.com/docpress/docpress) - Documentation website generator
+
+| Project | Description |
+| ------------------------------------------------ | ---------------------------------------- |
+| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
+| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
## Contributing
@@ -69,15 +70,42 @@ 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
```bash
-npm i && npm run dev
-open http://localhost:3000
+npm run bootstrap && npm run dev
```
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]
+
+
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)]
+
+
+
+
+
+
+
+
+
+
+
+
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+
+
## License
-MIT
+
+[MIT](LICENSE)
+
+[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)
diff --git a/app.js b/app.js
deleted file mode 100644
index beada16..0000000
--- a/app.js
+++ /dev/null
@@ -1,12 +0,0 @@
-var serveStatic = require('serve-static')
-var http = require('http')
-var fs = require('fs')
-
-http.createServer(function (req, res) {
- serveStatic('.')(req, res, function () {
- res.writeHead(404, { 'Content-Type': 'text/html' })
- res.end(fs.readFileSync('dev.html'))
- })
-}).listen(3000, '0.0.0.0')
-
-console.log(`\nListening at http://0.0.0.0:3000\n`)
diff --git a/build/build-css.js b/build/build-css.js
deleted file mode 100644
index 40672e0..0000000
--- a/build/build-css.js
+++ /dev/null
@@ -1,47 +0,0 @@
-var fs = require('fs')
-var cssnano = require('cssnano').process
-var resolve = require('path').resolve
-var postcss = require('postcss')
-var isProd = process.argv[process.argv.length - 1] !== '--dev'
-
-var processor = postcss([require('postcss-salad')({
- features: {
- precss: {
- properties: {
- preserve: true
- }
- }
- }
-})])
-
-var saveMin = function (file, content) {
- fs.writeFileSync(resolve(__dirname, '../lib/themes/', file), content)
-}
-var save = function (file, content) {
- fs.writeFileSync(resolve(__dirname, '../themes/', file), content)
-}
-var load = function (file) {
- return fs.readFileSync(resolve(__dirname, '../src/themes/', file)).toString()
-}
-var loadLib = function (file) {
- return fs.readFileSync(resolve(__dirname, '../themes/', file)).toString()
-}
-
-var list = fs.readdirSync(resolve(__dirname, '../src/themes'))
-
-list.forEach(function (file) {
- if (!/\.css$/.test(file)) return
- processor.process(load(file), { from: resolve(__dirname, '../src/themes/', file) })
- .then(function (result) {
- save(file, result.css)
- console.log('salad - ' + file)
- isProd && cssnano(loadLib(file))
- .then(function (result) {
- saveMin(file, result.css)
- console.log('cssnao - ' + file)
- })
- }).catch(function (err) {
- console.log(err)
- })
-})
-
diff --git a/build/build.js b/build/build.js
index a64089b..7b61224 100644
--- a/build/build.js
+++ b/build/build.js
@@ -1,62 +1,119 @@
-var rollup = require('rollup')
-var buble = require('rollup-plugin-buble')
-var commonjs = require('rollup-plugin-commonjs')
-var nodeResolve = require('rollup-plugin-node-resolve')
-var uglify = require('rollup-plugin-uglify')
-var isProd = process.argv[process.argv.length - 1] !== '--dev'
+const rollup = require('rollup')
+const buble = require('rollup-plugin-buble')
+const commonjs = require('rollup-plugin-commonjs')
+const nodeResolve = require('rollup-plugin-node-resolve')
+const uglify = require('rollup-plugin-uglify')
+const replace = require('rollup-plugin-replace')
+const isProd = process.env.NODE_ENV === 'production'
+const version = process.env.VERSION || require('../package.json').version
+const chokidar = require('chokidar')
+const path = require('path')
-var build = function (opts) {
+const build = function (opts) {
rollup
.rollup({
- entry: 'src/' + opts.entry,
- plugins: [buble(), commonjs(), nodeResolve()].concat(opts.plugins || [])
+ input: opts.input,
+ plugins: (opts.plugins || []).concat([
+ buble(),
+ commonjs(),
+ nodeResolve(),
+ replace({
+ __VERSION__: version,
+ 'process.env.SSR': false
+ })
+ ])
})
.then(function (bundle) {
- var dest = 'lib/' + (opts.output || opts.entry)
+ var dest = 'lib/' + (opts.output || opts.input)
console.log(dest)
bundle.write({
format: 'iife',
- moduleName: opts.moduleName || 'D',
- dest: dest
+ file: dest,
+ strict: false
})
})
.catch(function (err) {
console.error(err)
})
}
-
-build({
- entry: 'core/index.js',
- output: 'docsify.js'
-})
-
-var plugins = [
- { name: 'search', entry: 'search/index.js', moduleName: 'Search' },
- { name: 'ga', entry: 'ga.js', moduleName: 'GA' }
- // { name: 'front-matter', entry: 'front-matter/index.js', moduleName: 'FrontMatter' }
-]
-
-plugins.forEach(item => {
+const buildCore = function () {
build({
- entry: 'plugins/' + item.entry,
- output: 'plugins/' + item.name + '.js',
- moduleName: 'D.' + item.moduleName
+ input: 'src/core/index.js',
+ output: 'docsify.js'
})
-})
-if (isProd) {
- build({
- entry: 'core/index.js',
- output: 'docsify.min.js',
- plugins: [uglify()]
- })
- plugins.forEach(item => {
+ if (isProd) {
build({
- entry: 'plugins/' + item.entry,
- output: 'plugins/' + item.name + '.min.js',
- moduleName: 'D.' + item.moduleName,
+ input: 'src/core/index.js',
+ output: 'docsify.min.js',
plugins: [uglify()]
})
- })
+ }
+}
+const buildAllPlugin = function () {
+ var plugins = [
+ {name: 'search', input: 'search/index.js'},
+ {name: 'ga', input: 'ga.js'},
+ {name: 'matomo', input: 'matomo.js'},
+ {name: 'emoji', input: 'emoji.js'},
+ {name: 'external-script', input: 'external-script.js'},
+ {name: 'front-matter', input: 'front-matter/index.js'},
+ {name: 'zoom-image', input: 'zoom-image.js'},
+ {name: 'disqus', input: 'disqus.js'},
+ {name: 'gitalk', input: 'gitalk.js'}
+ ]
+
+ plugins.forEach(item => {
+ build({
+ input: 'src/plugins/' + item.input,
+ output: 'plugins/' + item.name + '.js'
+ })
+ })
+
+ if (isProd) {
+ plugins.forEach(item => {
+ build({
+ input: 'src/plugins/' + item.input,
+ output: 'plugins/' + item.name + '.min.js',
+ plugins: [uglify()]
+ })
+ })
+ }
+}
+
+if (!isProd) {
+ chokidar
+ .watch(['src/core', 'src/plugins'], {
+ atomic: true,
+ awaitWriteFinish: {
+ stabilityThreshold: 1000,
+ pollInterval: 100
+ }
+ })
+ .on('change', p => {
+ console.log('[watch] ', p)
+ const dirs = p.split(path.sep)
+ if (dirs[1] === 'core') {
+ buildCore()
+ } else if (dirs[2]) {
+ const name = path.basename(dirs[2], '.js')
+ const input = `src/plugins/${name}${
+ /\.js/.test(dirs[2]) ? '' : '/index'
+ }.js`
+
+ build({
+ input,
+ output: 'plugins/' + name + '.js'
+ })
+ }
+ })
+ .on('ready', () => {
+ console.log('[start]')
+ buildCore()
+ buildAllPlugin()
+ })
+} else {
+ buildCore()
+ buildAllPlugin()
}
diff --git a/build/cover.js b/build/cover.js
new file mode 100644
index 0000000..fbd27f7
--- /dev/null
+++ b/build/cover.js
@@ -0,0 +1,14 @@
+var fs = require('fs')
+var read = fs.readFileSync
+var write = fs.writeFileSync
+var version = process.env.VERSION || require('../package.json').version
+
+var file = __dirname + '/../docs/_coverpage.md'
+var cover = read(file, 'utf8').toString()
+
+console.log('Replace version number in cover page...')
+cover = cover.replace(
+ /(\S+)?<\/small>/g,
+ '' + version + ''
+)
+write(file, cover)
diff --git a/build/mincss.js b/build/mincss.js
new file mode 100644
index 0000000..f6c5ec2
--- /dev/null
+++ b/build/mincss.js
@@ -0,0 +1,12 @@
+const cssnano = require('cssnano').process
+const path = require('path')
+const fs = require('fs')
+
+files = fs.readdirSync(path.resolve('lib/themes'))
+
+files.forEach(file => {
+ file = path.resolve('lib/themes', file)
+ cssnano(fs.readFileSync(file)).then(result => {
+ fs.writeFileSync(file, result.css)
+ })
+})
diff --git a/build/release.sh b/build/release.sh
new file mode 100755
index 0000000..a328322
--- /dev/null
+++ b/build/release.sh
@@ -0,0 +1,50 @@
+set -e
+
+if [[ -z $1 ]]; then
+ echo "Enter new version: "
+ read VERSION
+else
+ VERSION=$1
+fi
+
+read -p "Releasing $VERSION $RELEASE_TAG - are you sure? (y/n) " -n 1 -r
+echo
+if [[ $REPLY =~ ^[Yy]$ ]]; then
+ echo "Releasing $VERSION ..."
+
+ npm run test
+
+ # build
+ VERSION=$VERSION npm run build
+
+ # update packages
+ cd packages/docsify-server-renderer
+ npm version $VERSION
+ if [[ -z $RELEASE_TAG ]]; then
+ npm publish
+ else
+ npm publish --tag $RELEASE_TAG
+ fi
+ cd -
+
+ # commit
+ git add -A
+ git commit -m "[build] $VERSION $RELEASE_TAG"
+ npm --no-git-tag-version version $VERSION --message "[release] $VERSION $RELEASE_TAG"
+
+ # changelog
+ node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s
+
+ git add .
+ git commit -m "chore: add changelog $VERSION"
+
+ # publish
+ git tag v$VERSION
+ git push origin refs/tags/v$VERSION
+ git push
+ if [[ -z $RELEASE_TAG ]]; then
+ npm publish
+ else
+ npm publish --tag $RELEASE_TAG
+ fi
+fi
diff --git a/build/ssr.js b/build/ssr.js
new file mode 100644
index 0000000..16b93ca
--- /dev/null
+++ b/build/ssr.js
@@ -0,0 +1,34 @@
+var rollup = require('rollup')
+var buble = require('rollup-plugin-buble')
+var async = require('rollup-plugin-async')
+var replace = require('rollup-plugin-replace')
+
+rollup
+ .rollup({
+ input: 'packages/docsify-server-renderer/index.js',
+ plugins: [
+ async(),
+ replace({
+ __VERSION__: process.env.VERSION || require('../package.json').version,
+ 'process.env.SSR': true
+ }),
+ buble({
+ transforms: {
+ generator: false
+ }
+ })
+ ],
+ onwarn: function () {}
+ })
+ .then(function (bundle) {
+ var dest = 'packages/docsify-server-renderer/build.js'
+
+ console.log(dest)
+ bundle.write({
+ format: 'cjs',
+ file: dest
+ })
+ })
+ .catch(function (err) {
+ console.error(err)
+ })
diff --git a/dev.html b/dev.html
deleted file mode 100644
index d928711..0000000
--- a/dev.html
+++ /dev/null
@@ -1,34 +0,0 @@
-
-
-
-
- docsify
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/README.md b/docs/README.md
index 51f2506..e625420 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,26 +2,31 @@
> A magical documentation site generator.
-## What is it
+## What it is
-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 a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
-See the [Quick start](/quickstart) for more details.
+See the [Quick start](quickstart.md) guide for more details.
## Features
-- Not build static html files
-- Simple and lightweight (~14kB gzipped)
+- No statically built html files
+- Simple and lightweight (~21kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
-- Compatible with IE10+
+- Emoji support
+- Compatible with IE11
+- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
## 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/docsifyjs/awesome-docsify#showcase) to see 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:
+## Community
+
+Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
index 45bc9f6..1decbd6 100644
--- a/docs/_coverpage.md
+++ b/docs/_coverpage.md
@@ -1,13 +1,12 @@
-# docsify 3.0
+# docsify 4.9.4
> A magical documentation site generator.
-- Simple and lightweight (~14kB gzipped)
-- Not build static html files
+- Simple and lightweight (~21kB gzipped)
+- No statically built html files
- Multiple themes
-
-[GitHub](https://github.com/QingWei-Li/docsify/)
-[Get Started](#docsify)
+[GitHub](https://github.com/docsifyjs/docsify/)
+[Getting Started](#docsify)
diff --git a/docs/_media/example.html b/docs/_media/example.html
new file mode 100644
index 0000000..d35ee16
--- /dev/null
+++ b/docs/_media/example.html
@@ -0,0 +1 @@
+
To infinity and Beyond!
\ No newline at end of file
diff --git a/docs/_media/example.js b/docs/_media/example.js
new file mode 100644
index 0000000..7b6f668
--- /dev/null
+++ b/docs/_media/example.js
@@ -0,0 +1,16 @@
+import fetch from 'fetch'
+
+const URL = 'https://example.com'
+const PORT = 8080
+
+/// [demo]
+const result = fetch(`${URL}:${PORT}`)
+ .then(function(response) {
+ return response.json();
+ })
+ .then(function(myJson) {
+ console.log(JSON.stringify(myJson));
+ });
+/// [demo]
+
+result.then(console.log).catch(console.error)
diff --git a/docs/_media/example.md b/docs/_media/example.md
new file mode 100644
index 0000000..6ee6494
--- /dev/null
+++ b/docs/_media/example.md
@@ -0,0 +1 @@
+> This is from the `example.md`
diff --git a/docs/_navbar.md b/docs/_navbar.md
new file mode 100644
index 0000000..47a2356
--- /dev/null
+++ b/docs/_navbar.md
@@ -0,0 +1,6 @@
+- Translations
+ - [:uk: English](/)
+ - [:cn: 中文](/zh-cn/)
+ - [:de: Deutsch](/de-de/)
+ - [:es: Spanish](/es/)
+ - [:ru: Russian](/ru/)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index 3753426..051514b 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -1,20 +1,28 @@
- Getting started
- - [Quick start](/quickstart)
- - [Writing more pages](/more-pages)
- - [Custom navbar](/custom-navbar)
- - [Cover page](/cover)
+
+ - [Quick start](quickstart.md)
+ - [Writing more pages](more-pages.md)
+ - [Custom navbar](custom-navbar.md)
+ - [Cover page](cover.md)
- Customization
- - [Configuration](/configuration)
- - [Themes](/themes)
- - [Using plugins](/plugins)
- - [Markdown configuration](/markdown)
- - [Lanuage highlight](/language-highlight)
+
+ - [Configuration](configuration.md)
+ - [Themes](themes.md)
+ - [List of Plugins](plugins.md)
+ - [Write a Plugin](write-a-plugin.md)
+ - [Markdown configuration](markdown.md)
+ - [Language highlighting](language-highlight.md)
- Guide
- - [Deploy](/deploy)
- - [Doc helper](/helpers)
- - [Compatible Vue](/vue)
- - [CDN](/cdn)
-- [Changelog](/changelog)
\ No newline at end of file
+ - [Deploy](deploy.md)
+ - [Helpers](helpers.md)
+ - [Vue compatibility](vue.md)
+ - [CDN](cdn.md)
+ - [Offline Mode(PWA)](pwa.md)
+ - [Server-Side Rendering(SSR)](ssr.md)
+ - [Embed Files](embed-files.md)
+
+- [Awesome docsify](awesome.md)
+- [Changelog](changelog.md)
diff --git a/docs/cdn.md b/docs/cdn.md
index 1e0b2ec..eba77a8 100644
--- a/docs/cdn.md
+++ b/docs/cdn.md
@@ -2,10 +2,8 @@
Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon as it is published to npm. You can also browse the source of the npm package at [unpkg.com/docsify/](//unpkg.com/docsify/).
-
## Latest version
-
```html
@@ -14,8 +12,9 @@ Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon
```
-## Specific version
+Alternatively, use [compressed files](#compressed-file).
+## Specific version
```html
@@ -27,7 +26,6 @@ Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon
## Compressed file
-
```html
@@ -36,7 +34,17 @@ Recommended: [unpkg](//unpkg.com), which will reflect the latest version as soon
```
+```html
+
+
+
+
+
+```
+
## Other CDN
-[jsDelivr](http://www.jsdelivr.com/projects/docsify) is available.
+- http://www.bootcdn.cn/docsify
+- https://cdn.jsdelivr.net/npm/docsify/
+- https://cdnjs.com/libraries/docsify
diff --git a/docs/configuration.md b/docs/configuration.md
index 26e3f0d..ba48475 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,30 +1,17 @@
# Configuration
-docsify supports two ways to configure. You can configure the `window.$docsify` or write configuration on the script tag via `data-*` attributes.
+You can configure the `window.$docsify`.
```html
-
-
-
-
```
-Both ways are compatible. However, the first way is recommended. It is clear and can be configured in a separate file.
-
-!> In `window.$docsfiy`, the options should be written by camelCase.
-
## el
- Type: `String`
@@ -35,7 +22,7 @@ The DOM element to be mounted on initialization. It can be a CSS selector string
```js
window.$docsify = {
el: '#app'
-}
+};
```
## repo
@@ -47,14 +34,13 @@ Configure the repository url or a string of `username/repo` can add the [GitHub
```js
window.$docsify = {
- repo: 'QingWei-Li/docsify',
+ repo: 'docsifyjs/docsify',
// or
- repo: 'https://github.com/QingWei-Li/docsify/'
-}
+ repo: 'https://github.com/docsifyjs/docsify/'
+};
```
-
-## max-level
+## maxLevel
- Type: `Number`
- Default: `6`
@@ -64,15 +50,15 @@ Maximum Table of content level.
```js
window.$docsify = {
maxLevel: 4
-}
+};
```
-## load-navbar
+## loadNavbar
- Type: `Boolean|String`
- Default: `false`
-Load navbar from Markdown file. If **true** it will be loaded from `_navbar.md`.
+Loads navbar from the Markdown file `_navbar.md` if **true**, or else from the path specified.
```js
window.$docsify = {
@@ -81,16 +67,15 @@ window.$docsify = {
// load from nav.md
loadNavbar: 'nav.md'
-}
+};
```
-## load-sidebar
+## loadSidebar
- Type: `Boolean|String`
- Default: `false`
-
-Load sidebar from Markdown file. If **true** it will be loaded from `_sidebar.md`.
+Loads sidebar from the Markdown file `_sidebar.md` if **true**, or else from the path specified.
```js
window.$docsify = {
@@ -99,44 +84,40 @@ window.$docsify = {
// load from summary.md
loadSidebar: 'summary.md'
-}
+};
```
-## sub-max-level
+## subMaxLevel
- Type: `Number`
- Default: `0`
-Add TOC in custom sidebar.
+Add table of contents (TOC) in custom sidebar.
```js
window.$docsify = {
subMaxLevel: 2
-}
+};
```
-
## auto2top
- Type: `Boolean`
- Default: `false`
-
Scrolls to the top of the screen when the route is changed.
```js
window.$docsify = {
auto2top: true
-}
+};
```
-
## homepage
- Type: `String`
- Default: `README.md`
-
`README.md` in your docs folder will be treated as homepage for your website, but sometimes you may need to serve another file as your homepage.
```js
@@ -145,11 +126,12 @@ window.$docsify = {
homepage: 'home.md',
// Or use the readme in your repo
- homepage: 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
-}
+ homepage:
+ 'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md'
+};
```
-## base-path
+## basePath
- Type: `String`
@@ -163,41 +145,101 @@ window.$docsify = {
basePath: 'https://docsify.js.org/',
// Even can load files from other repo
- basePath: 'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
-}
+ basePath:
+ 'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
+};
```
+## relativePath
+
+- Type: `Boolean`
+- Default: `false`
+
+If **true** links are relative to the current context.
+
+For example, the directory structure is as follows:
+
+```text
+.
+└── docs
+ ├── README.md
+ ├── guide.md
+ └── zh-cn
+ ├── README.md
+ ├── guide.md
+ └── config
+ └── example.md
+```
+
+With relative path **enabled** and current URL `http://domain.com/zh-cn/README`, given links will resolve to:
+
+```text
+guide.md => http://domain.com/zh-cn/guide
+config/example.md => http://domain.com/zh-cn/config/example
+../README.md => http://domain.com/README
+/README.md => http://domain.com/README
+```
+
+```js
+window.$docsify = {
+ // Relative path enabled
+ relativePath: true,
+
+ // Relative path disabled (default value)
+ relativePath: false
+};
+```
## coverpage
-- Type: `Boolean|String`
+- Type: `Boolean|String|String[]|Object`
- Default: `false`
-Activate the [cover feature](/cover). If ture, it will load from `_coverpage.md`.
+Activate the [cover feature](cover.md). If true, it will load from `_coverpage.md`.
```js
window.$docsify = {
coverpage: true,
// Custom file name
- coverpage: 'cover.md'
-}
+ coverpage: 'cover.md',
+
+ // mutiple covers
+ coverpage: ['/', '/zh-cn/'],
+
+ // mutiple covers and custom file name
+ coverpage: {
+ '/': 'cover.md',
+ '/zh-cn/': 'cover.md'
+ }
+};
+```
+
+## logo
+
+- Type: `String`
+
+Website logo as it appears in the sidebar, you can resize by CSS.
+
+```js
+window.$docsify = {
+ logo: '/_media/icon.svg'
+};
```
## name
- Type: `String`
-
-Website name appears in the sidebar.
+Website name as it appears in the sidebar.
```js
window.$docsify = {
name: 'docsify'
-}
+};
```
-## name-link
+## nameLink
- Type: `String`
- Default: `window.location.pathname`
@@ -206,16 +248,21 @@ The name of the link.
```js
window.$docsify = {
- nameLink: '/'
-}
+ nameLink: '/',
+
+ // For each route
+ nameLink: {
+ '/zh-cn/': '/zh-cn/',
+ '/': '/'
+ }
+};
```
## markdown
- Type: `Function`
-See [Markdown configuration](/markdown).
-
+See [Markdown configuration](markdown.md).
```js
window.$docsify = {
@@ -230,65 +277,66 @@ window.$docsify = {
},
// function
- markdown: function (marked, renderer) {
+ markdown: function(marked, renderer) {
// ...
- return marked
+ return marked;
}
-}
+};
```
-## theme-color
+## themeColor
- Type: `String`
-Customize the theme color.
-Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in old browser.
+Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in old browser.
```js
window.$docsify = {
themeColor: '#3F51B5'
-}
+};
```
## alias
- Type: `Object`
-
-Set the route alias. You can freely manage routing rules.
+Set the route alias. You can freely manage routing rules. Supports RegExp.
```js
window.$docsify = {
alias: {
+ '/foo/(+*)': '/bar/$1', // supports regexp
'/zh-cn/changelog': '/changelog',
- '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG'
+ '/changelog':
+ 'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG',
+ '/.*/_sidebar.md': '/_sidebar.md' // See #301
}
-}
+};
```
-## auto-header
+## autoHeader
- type: `Boolean`
-If `loadSidebar` and `autoHeader` are both enabled, for each link in _sidebar.md, prepend a header to the page before converting it to html. [#78](https://github.com/QingWei-Li/docsify/issues/78)
+If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to html. Compare [#78](https://github.com/docsifyjs/docsify/issues/78).
```js
window.$docsify = {
loadSidebar: true,
autoHeader: true
-}
+};
```
-## execute-script
+## executeScript
- type: `Boolean`
-Execute the script on the page. Only parse the first script tag([demo](themes)). If Vue is present, it is turned on by default.
+Execute the script on the page. Only parse the first script tag([demo](themes)). If Vue is present, it is turned on by default.
```js
window.$docsify = {
executeScript: true
-}
+};
```
```markdown
@@ -297,6 +345,174 @@ window.$docsify = {
-
```
+Note that if you are running an external script, e.g. an embedded jsfiddle demo, make sure to include the [external-script](plugins.md?id=external-script) plugin.
+
+## noEmoji
+
+- type: `Boolean`
+
+Disabled emoji parse.
+
+```js
+window.$docsify = {
+ noEmoji: true
+};
+```
+
+## mergeNavbar
+
+- type: `Boolean`
+
+Navbar will be merged with the sidebar on smaller screens.
+
+```js
+window.$docsify = {
+ mergeNavbar: true
+};
+```
+
+## formatUpdated
+
+- type: `String|Function`
+
+We can display the file update date through **{docsify-updated}** variable. And format it by `formatUpdated`.
+See https://github.com/lukeed/tinydate#patterns
+
+```js
+window.$docsify = {
+ formatUpdated: '{MM}/{DD} {HH}:{mm}',
+
+ formatUpdated: function(time) {
+ // ...
+
+ return time;
+ }
+};
+```
+
+## externalLinkTarget
+
+- type: `String`
+- default: `_blank`
+
+Target to open external links. Default `'_blank'` (new window/tab)
+
+```js
+window.$docsify = {
+ externalLinkTarget: '_self' // default: '_blank'
+};
+```
+
+## routerMode
+
+- type: `String`
+- default: `hash`
+
+```js
+window.$docsify = {
+ routerMode: 'history' // default: 'hash'
+};
+```
+
+## noCompileLinks
+
+- type: `Array`
+
+Sometimes we do not want docsify to handle our links. See [#203](https://github.com/docsifyjs/docsify/issues/203)
+
+```js
+window.$docsify = {
+ noCompileLinks: ['/foo', '/bar/.*']
+};
+```
+
+## onlyCover
+
+- type: `Boolean`
+
+Only coverpage is loaded when visiting the home page.
+
+```js
+window.$docsify = {
+ onlyCover: false
+};
+```
+
+## requestHeaders
+
+- type: `Object`
+
+Set the request resource headers.
+
+```js
+window.$docsify = {
+ requestHeaders: {
+ 'x-token': 'xxx'
+ }
+};
+```
+
+## ext
+
+- type: `String`
+
+Request file extension.
+
+```js
+window.$docsify = {
+ ext: '.md'
+};
+```
+
+## fallbackLanguages
+
+- type: `Array`
+
+List of languages that will fallback to the default language when a page is request and didn't exists for the given local.
+
+Example:
+
+- try to fetch the page of `/de/overview`. If this page exists, it'll be displayed
+- then try to fetch the default page `/overview` (depending on the default language). If this page exists, it'll be displayed
+- then display 404 page.
+
+```js
+window.$docsify = {
+ fallbackLanguages: ['fr', 'de']
+};
+```
+
+## notFoundPage
+
+- type: `Boolean` | `String` | `Object`
+
+Load the `_404.md` file:
+
+```js
+window.$docsify = {
+ notFoundPage: true
+};
+```
+
+Load the customised path of the 404 page:
+
+```js
+window.$docsify = {
+ notFoundPage: 'my404.md'
+};
+```
+
+Load the right 404 page according to the localisation:
+
+```js
+window.$docsify = {
+ notFoundPage: {
+ '/': '_404.md',
+ '/de': 'de/_404.md'
+ }
+};
+```
+
+> Note: The options with fallbackLanguages didn't work with the `notFoundPage` options.
diff --git a/docs/cover.md b/docs/cover.md
index 2a538e7..555f4ff 100644
--- a/docs/cover.md
+++ b/docs/cover.md
@@ -1,57 +1,99 @@
# Cover
-Activate the cover feature by setting `coverpage`. The detail in [Configuration#coverpage](configuration#coverpage).
+Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#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
+
+
-# docsify
+# docsify 3.5
> A magical documentation site generator.
-- Simple and lightweight (~12kb gzipped)
+- Simple and lightweight (~21kB gzipped)
+- No statically built html files
- Multiple themes
-- Not build static html files
-
-[GitHub](https://github.com/QingWei-Li/docsify/)
-[Get Started](#quick-start)
+[GitHub](https://github.com/docsifyjs/docsify/)
+[Get Started](#docsify)
```
-!> A document site can have only one cover page.
+!> A document site can have only one coverpage!
## 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 a background image:
```markdown
-# docsify
+
-[GitHub](https://github.com/QingWei-Li/docsify/)
+# docsify 3.5
+
+[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](#quick-start)
+
+
+
```
+
+## Coverpage as homepage
+
+Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [onlyCover option](configuration.md#onlycover).
+
+## Multiple covers
+
+If your docs site is in more than one language, it may be useful to set multiple covers.
+
+For example, your docs structure is like this
+
+```text
+.
+└── docs
+ ├── README.md
+ ├── guide.md
+ ├── _coverpage.md
+ └── zh-cn
+ ├── README.md
+ └── guide.md
+ └── _coverpage.md
+```
+
+Now, you can set
+
+```js
+window.$docsify = {
+ coverpage: ['/', '/zh-cn/']
+};
+```
+
+Or a special file name
+
+```js
+window.$docsify = {
+ coverpage: {
+ '/': 'cover.md',
+ '/zh-cn/': 'cover.md'
+ }
+};
+```
diff --git a/docs/custom-navbar.md b/docs/custom-navbar.md
index cc78741..324ad81 100644
--- a/docs/custom-navbar.md
+++ b/docs/custom-navbar.md
@@ -1,10 +1,14 @@
# 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.
+
+!> Note that documentation links begin with `#/`.
```html
+
+
+
+
+### Sponsors
+
+Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/HISTORY.md b/HISTORY.md
index 6c9358e..fb720fd 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -1,386 +1,736 @@
-### 2.4.3
-> 2017-02-15
-
-#### Bug fixes
-* fix emoji replacing error (#76)
-
-### 2.4.2
-
-> 2017-02-14
-
-#### Bug fixes
-- fix(index): load file path error
+
+## [3.7.3](https://github.com/QingWei-Li/docsify/compare/v3.7.2...v3.7.3) (2017-05-22)
-### 2.4.1
+### Bug Fixes
-> 2017-02-13
-
-#### Bug fixes
-- fix(index): cover page
-
-### 2.4.0
-
-> 2017-02-13
-
-#### Features
-
-- feat(hook): add `doneEach`
+* **render:** find => filter ([eca3368](https://github.com/QingWei-Li/docsify/commit/eca3368))
-### 2.3.0
-> 2017-02-13
-
-#### Features
-
-- feat(src): add alias feature
-- docs: update all documents
-- feat(src): dynamic title
-- feat(hook): support custom plugin
-- feat(themes): add dark theme
-
-#### Bug fixes
-- fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
-- fix: sidebar style
-- fix(render): fix render link
-
-### 2.2.1
-
-> 2017-02-11
-
-#### Bug fixes
-- fix(search): crash when not content, fixed #68
-- fix(event): scroll active sidebar
-- fix(search): not work in mobile
-
-### 2.2.0
-
-#### Features
-- Add `Google Analytics` plugin.
-```html
-
-
-```
-
-### 2.1.0
-#### Features
-- Add search plugin
-```html
-
-
-```
-
-#### Bug fixes
-- fix sidebar style
-
-### 2.0.3
-#### Bug fixes
-- fix: rendering emojis
-- fix: css var polyfill
-
-### 2.0.2
-
-#### Bug fixes
-- fix button style in cover page.
-
-### 2.0.1
-#### Bug fixes
-- border style.
-
-### 2.0.0
-#### Features
-- Customize the theme color
-
-#### Break change
-- Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
+
+## [3.7.2](https://github.com/QingWei-Li/docsify/compare/v3.7.1...v3.7.2) (2017-05-19)
-### 1.10.5
-#### Bug fixes
-- fix initialize the Vue instance
-### 1.10.4
-#### Bug fixes
-- fix execute script
+
+## [3.7.1](https://github.com/QingWei-Li/docsify/compare/v3.7.0...v3.7.1) (2017-05-19)
-### 1.10.3
-#### Bug fixes
-- compatible vuep QingWei-Li/vuep/issues/2
-- fix sidebar scroll, fixed #63
-### 1.10.2
-#### Bug fixes
-- Fix render emojis again
+### Bug Fixes
-### 1.10.1
-#### Bug fixes
-- Fix render emojis
+* docsify-updated is undefined ([b2b4742](https://github.com/QingWei-Li/docsify/commit/b2b4742))
-### 1.10.0
-#### Features
-- Support emoji :laughing:
-### 1.9.0
-#### Bug fixes
-- Destroys the vue instance when the route is changed
+
+# [3.7.0](https://github.com/QingWei-Li/docsify/compare/v3.6.6...v3.7.0) (2017-05-16)
-#### Features
-- Add `!>` and `?>` doc helper.
-
-#### Break change
-- Remove `!` doc helper.
-
-### 1.8.0
-#### Bug fixes
-- Using `v-pre` skip compilation.
### Features
-- Execute script when vue exists.
-### 1.7.4
-#### Bug fixes
-- Fix bugs caused by the previous version
+* add docsify-updated, close [#158](https://github.com/QingWei-Li/docsify/issues/158) ([d2be5ae](https://github.com/QingWei-Li/docsify/commit/d2be5ae))
+* add externalLinkTarget, close [#149](https://github.com/QingWei-Li/docsify/issues/149) ([2d73285](https://github.com/QingWei-Li/docsify/commit/2d73285))
-### 1.7.3
-#### Bug fixes
-- Add `hr` style
-- Fixed option is an empty string
-### 1.7.2
-#### Bug fixes
-- Fix sidebar click event in mobile browser.
-### 1.7.1
-#### Bug fixes
-- Fix sidebar style in mobile browser.
+
+## [3.6.6](https://github.com/QingWei-Li/docsify/compare/v3.6.5...v3.6.6) (2017-05-06)
-### 1.7.0
-
-#### Bug fixes
-- Fixed custom cover background, fixed #52
-- Fixed sticky sidebar
### Features
-- Add `name` and `nameLink`
-### 1.6.1
-#### Bug fixes
-- Fixed sidebar bug when the coverpage exist
-
-### 1.6.0
-#### Features
-- Improve sidebar performance. The active item is automatically scrolled in the visible view.
-- New doc helper: `! `. e.g. `! content` will be rendered as `
+ 
+ 
+ 
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+
+ 