diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 0bd565e..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,2 +0,0 @@
-
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..35d6b90
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+
+
+
+
+## Bug Report
+
+#### Steps to reproduce
+
+
+
+#### What is current behaviour
+
+
+
+#### What is the expected behaviour
+
+
+
+#### Other relevant information
+
+
+- [ ] Bug does still occur when all/other plugins are disabled?
+
+- Your OS:
+- Node.js version:
+- npm/yarn version:
+- Browser version:
+- Docsify version:
+- Docsify plugins:
+
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..501e4de
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+
+
+
+
+## Feature request
+
+#### What problem does this feature solve?
+
+
+
+#### What does the proposed API look like?
+
+
+
+#### How should this be implemented in your opinion?
+
+
+
+#### Are you willing to work on this yourself?
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 79a5281..bb31bd4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,54 @@
-Please makes sure these boxes are checked before submitting your PR, thank you!
+
+
+
+
+
+
+**Summary**
+
+**What kind of change does this PR introduce?** (check at least one)
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update
+- [ ] Refactor
+- [ ] Docs
+- [ ] Build-related changes
+- [ ] Other, please describe:
+
+If changing the UI of default theme, please provide the **before/after** screenshot:
+
+**Does this PR introduce a breaking change?** (check one)
+
+- [ ] Yes
+- [ ] No
+
+If yes, please describe the impact and migration path for existing applications:
+
+**The PR fulfills these requirements:**
+
+- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
+
+You have tested in the following browsers: (Providing a detailed version will be better.)
+
+- [ ] Chrome
+- [ ] Firefox
+- [ ] Safari
+- [ ] Edge
+- [ ] IE
+
+If adding a **new feature**, the PR's description includes:
+
+- [ ] A convincing reason for adding this feature
+- [ ] Related documents have been updated
+- [ ] Related tests have been updated
+
+To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
+
+
+**Other information:**
+
+---
-* [ ] Make sure you are merging your commits to `master` branch.
-* [ ] Add some descriptions and refer relative issues for you PR.
* [ ] DO NOT include files inside `lib` directory.
+
diff --git a/.gitignore b/.gitignore
index 556ff6c..ea4b5b8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,9 @@
*.log
.DS_Store
-/themes/*
-!.gitkeep
+.idea
node_modules
-/lib/
-.idea
\ No newline at end of file
+themes/
+lib/
+
+# exceptions
+!.gitkeep
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e275ef8..267d402 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,123 +1,234 @@
+Glod Sponsor via Open Collective
+Gold Sponsor via Open Collective
-
+
## Links
+- [`develop` branch preview](https://docsifyjs.netlify.com/)
- [Documentation](https://docsify.js.org)
- [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)
@@ -36,23 +37,25 @@
## Features
- No statically built html files
-- Simple and lightweight (~19kB gzipped)
+- 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
-Look at [this tutorial](https://docsify.js.org/#/quickstart) or [online demo](https://jsfiddle.net/7ztb8qsr/1/).
+Look at [this tutorial](https://docsify.js.org/#/quickstart)
+
+[](https://codesandbox.io/s/307qqv236)
## Showcase
These projects are using docsify to generate their sites. Pull requests welcome :blush:
-Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify)
+Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
## Similar projects
@@ -103,6 +106,6 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
## License
-MIT
+[MIT](LICENSE)
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)
diff --git a/build/build.js b/build/build.js
index c7e8c1b..7b61224 100644
--- a/build/build.js
+++ b/build/build.js
@@ -9,7 +9,7 @@ const version = process.env.VERSION || require('../package.json').version
const chokidar = require('chokidar')
const path = require('path')
-const build = function(opts) {
+const build = function (opts) {
rollup
.rollup({
input: opts.input,
@@ -23,7 +23,7 @@ const build = function(opts) {
})
])
})
- .then(function(bundle) {
+ .then(function (bundle) {
var dest = 'lib/' + (opts.output || opts.input)
console.log(dest)
@@ -33,11 +33,11 @@ const build = function(opts) {
strict: false
})
})
- .catch(function(err) {
+ .catch(function (err) {
console.error(err)
})
}
-const buildCore = function() {
+const buildCore = function () {
build({
input: 'src/core/index.js',
output: 'docsify.js'
@@ -51,10 +51,11 @@ const buildCore = function() {
})
}
}
-const buildAllPlugin = function() {
+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'},
diff --git a/build/release.sh b/build/release.sh
old mode 100644
new mode 100755
index da15a38..a328322
--- a/build/release.sh
+++ b/build/release.sh
@@ -29,7 +29,6 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
# commit
git add -A
- git add -f lib/ -A
git commit -m "[build] $VERSION $RELEASE_TAG"
npm --no-git-tag-version version $VERSION --message "[release] $VERSION $RELEASE_TAG"
diff --git a/docs/README.md b/docs/README.md
index 3a7721d..e625420 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,26 +2,26 @@
> 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. 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.md).
+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.md) for more details.
+See the [Quick start](quickstart.md) guide for more details.
## Features
- No statically built html files
-- Simple and lightweight (~19kB gzipped)
+- Simple and lightweight (~21kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support
-- Compatible with IE10+
-- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
+- Compatible with IE11
+- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
## Examples
-Check out the [Showcase](https://github.com/docsifyjs/docsify/#showcase) to docsify in use.
+Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see docsify in use.
## Donate
@@ -29,4 +29,4 @@ Please consider donating if you think docsify is helpful to you or that my work
## Community
-Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby).
+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 0aef7b7..1decbd6 100644
--- a/docs/_coverpage.md
+++ b/docs/_coverpage.md
@@ -1,12 +1,12 @@
-# docsify 4.7.1
+# docsify 4.9.4
> A magical documentation site generator.
-* Simple and lightweight (~19kB gzipped)
-* No statically built html files
-* Multiple themes
+- Simple and lightweight (~21kB gzipped)
+- No statically built html files
+- Multiple themes
[GitHub](https://github.com/docsifyjs/docsify/)
[Getting Started](#docsify)
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/_sidebar.md b/docs/_sidebar.md
index 8dc8c9e..051514b 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -1,28 +1,28 @@
-* Getting started
+- Getting started
- * [Quick start](quickstart.md)
- * [Writing more pages](more-pages.md)
- * [Custom navbar](custom-navbar.md)
- * [Cover page](cover.md)
+ - [Quick start](quickstart.md)
+ - [Writing more pages](more-pages.md)
+ - [Custom navbar](custom-navbar.md)
+ - [Cover page](cover.md)
-* Customization
+- Customization
- * [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)
+ - [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
+- Guide
- * [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 (new)](embed-files.md)
+ - [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)
+- [Awesome docsify](awesome.md)
+- [Changelog](changelog.md)
diff --git a/docs/configuration.md b/docs/configuration.md
index 830748f..ba48475 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -150,6 +150,46 @@ window.$docsify = {
};
```
+## 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|String[]|Object`
diff --git a/docs/cover.md b/docs/cover.md
index 74025d1..555f4ff 100644
--- a/docs/cover.md
+++ b/docs/cover.md
@@ -26,9 +26,9 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:
> A magical documentation site generator.
-* Simple and lightweight (~19kB gzipped)
-* No statically built html files
-* Multiple themes
+- Simple and lightweight (~21kB gzipped)
+- No statically built html files
+- Multiple themes
[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](#docsify)
diff --git a/docs/deploy.md b/docs/deploy.md
index fdf0167..a879f2e 100644
--- a/docs/deploy.md
+++ b/docs/deploy.md
@@ -15,7 +15,7 @@ It is recommended that you save your files to the `./docs` subfolder of the `mas
!> You can also save files in the root directory and select `master branch`.
-You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch
+You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
## GitLab Pages
@@ -87,3 +87,45 @@ When using the HTML5 router, you need to set up redirect rules that redirect all
```sh
/* /index.html 200
```
+
+## AWS Amplify
+
+1. Set the routerMode in the Docsify project `index.html` to *history* mode.
+
+```html
+
+```
+
+2. Login to your [AWS Console](https://aws.amazon.com).
+3. Go to the [AWS Amplify Dashboard](https://aws.amazon.com/amplify).
+4. Choose the **Deploy** route to setup your project.
+5. When prompted, keep the build settings empty if you're serving your docs within the root directory. If you're serving your docs from a different directory, customise your amplify.yml
+
+```yml
+version: 0.1
+frontend:
+ phases:
+ build:
+ commands:
+ - echo "Nothing to build"
+ artifacts:
+ baseDirectory: /docs
+ files:
+ - '**/*'
+ cache:
+ paths: []
+
+```
+
+6. Add the following Redirect rules in their displayed order.
+
+| Source address | Target address | Type |
+|----------------|----------------|---------------|
+| /<*>.md | /<*>.md | 200 (Rewrite) |
+| /<*> | /index.html | 200 (Rewrite) |
+
diff --git a/docs/embed-files.md b/docs/embed-files.md
index a935dd3..dab2efe 100644
--- a/docs/embed-files.md
+++ b/docs/embed-files.md
@@ -39,6 +39,21 @@ You will get it
[filename](_media/example.md ':include :type=code')
+## Embedded code fragments
+Sometimes you don't want to embed a whole file. Maybe because you need just a few lines but you want to compile and test the file in CI.
+
+```markdown
+[filename](_media/example.js ':include :type=code :fragment=demo')
+```
+
+In your code file you need to surround the fragment between `/// [demo]` lines (before and after the fragment).
+Alternatively you can use `### [demo]`.
+
+Example:
+
+[filename](_media/example.js ':include :type=code :fragment=demo')
+
+
## Tag attribute
If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.
diff --git a/docs/helpers.md b/docs/helpers.md
index 8016831..b047d36 100644
--- a/docs/helpers.md
+++ b/docs/helpers.md
@@ -88,9 +88,58 @@ You will get `link `html. Do not worry, you can still set ti
+
```
+
+## Customise ID for headings
+
+```md
+### δ½ ε₯½οΌδΈηοΌ :id=hello-world
+```
+
+## Markdown in html tag
+
+You need to insert a space between the html and markdown content.
+This is useful for rendering markdown content in the details element.
+
+```markdown
+
+Self-assessment (Click to expand)
+
+- Abc
+- Abc
+
+
+```
+
+
+Self-assessment (Click to expand)
+
+- Abc
+- Abc
+
+
+
+Or markdown content can be wrapped in html tag.
+
+```markdown
+
+
+- listitem
+- listitem
+- listitem
+
+
+```
+
+
+
+- Abc
+- Abc
+
+
diff --git a/docs/index.html b/docs/index.html
index e07c79e..6d0e008 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -44,6 +44,10 @@
maxLevel: 4,
subMaxLevel: 2,
ga: 'UA-106147152-1',
+ matomo: {
+ host: '//matomo.thunderwave.de',
+ id: 6
+ },
name: 'docsify',
search: {
noData: {
@@ -84,6 +88,7 @@
+
diff --git a/docs/markdown.md b/docs/markdown.md
index d03d5ec..c506e17 100644
--- a/docs/markdown.md
+++ b/docs/markdown.md
@@ -36,6 +36,7 @@ window.$docsify = {
// ' + mermaid.render(lang, code) + "
"
+ '' + mermaid.render('mermaid-svg-' + num++, code) + "
"
);
}
return this.origin.code.apply(this, arguments);
diff --git a/docs/more-pages.md b/docs/more-pages.md
index fba0a4d..46e7df8 100644
--- a/docs/more-pages.md
+++ b/docs/more-pages.md
@@ -51,6 +51,10 @@ Create the `_sidebar.md`:
You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
+## Nested Sidebars
+
+You may want the sidebar to update with only navigation to reflect the current directory. This can be done by adding a `_sidebar.md` file to each folder.
+
`_sidebar.md` is loaded from each level directory. If the current directory doesn't have `_sidebar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_sidebar.md` will be loaded from `/guide/_sidebar.md`.
You can specify `alias` to avoid unnecessary fallback.
@@ -66,6 +70,18 @@ You can specify `alias` to avoid unnecessary fallback.
```
+!> You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
+
+## Set Page Titles from Sidebar Selection
+
+A page's `title` tag is generated from the _selected_ sidebar item name. For better SEO, you can customize the title by specifying a string after the filename.
+
+```markdown
+
+* [Home](/)
+* [Guide](guide.md "The greatest guide in the world")
+```
+
## Table of Contents
Once you've created `_sidebar.md`, the sidebar content is automatically generated based on the headers in the markdown files.
diff --git a/docs/plugins.md b/docs/plugins.md
index 8983150..3706b89 100644
--- a/docs/plugins.md
+++ b/docs/plugins.md
@@ -37,7 +37,13 @@ By default, the hyperlink on the current page is recognized and the content is s
},
// Headline depth, 1 - 6
- depth: 2
+ depth: 2,
+
+ hideOtherSidebarContent: false, // whether or not to hide other sidebar content
+
+ // To avoid search index collision
+ // between multiple websites under the same domain
+ namespace: 'website-1',
}
}
@@ -93,7 +99,7 @@ Medium's image zoom. Based on [medium-zoom](https://github.com/francoischalifour
Exclude the special image
```markdown
-
+
```
## Edit on github
@@ -177,3 +183,15 @@ window.$docsify = {
]
}
```
+
+## Tabs
+
+A docsify.js plugin for displaying tabbed content from markdown.
+
+- [Documentation & Demos](https://jhildenbiddle.github.io/docsify-tabs)
+
+Provided by [@jhildenbiddle](https://github.com/jhildenbiddle/docsify-tabs).
+
+## More plugins
+
+See [awesome-docsify](awesome?id=plugins)
diff --git a/docs/ssr.md b/docs/ssr.md
index 3fa6879..e9c435f 100644
--- a/docs/ssr.md
+++ b/docs/ssr.md
@@ -111,7 +111,7 @@ var readFileSync = require('fs').readFileSync
// init
var renderer = new Renderer({
- template: readFileSync('./docs/index.template.html', 'utf-8').,
+ template: readFileSync('./docs/index.template.html', 'utf-8'),
config: {
name: 'docsify',
repo: 'docsifyjs/docsify'
diff --git a/docs/vue.md b/docs/vue.md
index 3fcfdb1..a1b5683 100644
--- a/docs/vue.md
+++ b/docs/vue.md
@@ -42,7 +42,7 @@ You can manually initialize a Vue instance.
```markdown
# Vue demo
-hello {{ msg }}
+hello {{ msg }}
diff --git a/index.html b/index.html
index f15433b..59e6911 100644
--- a/index.html
+++ b/index.html
@@ -21,48 +21,64 @@
+
+
+
+
