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 ebd062e..267d402 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,164 +1,234 @@
+4.8.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/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 38184a2..46e7df8 100644
--- a/docs/more-pages.md
+++ b/docs/more-pages.md
@@ -72,6 +72,16 @@ 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 ae4e466..3706b89 100644
--- a/docs/plugins.md
+++ b/docs/plugins.md
@@ -40,6 +40,10 @@ By default, the hyperlink on the current page is recognized and the content is s
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',
}
}
@@ -95,7 +99,7 @@ Medium's image zoom. Based on [medium-zoom](https://github.com/francoischalifour
Exclude the special image
```markdown
-
+
```
## Edit on github
@@ -184,6 +188,10 @@ window.$docsify = {
A docsify.js plugin for displaying tabbed content from markdown.
-* [Documentation & Demos](https://jhildenbiddle.github.io/docsify-tabs)
+- [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/write-a-plugin.md b/docs/write-a-plugin.md
index 2f5af37..baa894e 100644
--- a/docs/write-a-plugin.md
+++ b/docs/write-a-plugin.md
@@ -6,41 +6,41 @@ A plugin is simply a function that takes `hook` as an argument. The hook support
```js
window.$docsify = {
- plugins: [
- function (hook, vm) {
- hook.init(function() {
- // Called when the script starts running, only trigger once, no arguments,
- })
+ plugins: [
+ function(hook, vm) {
+ hook.init(function() {
+ // Called when the script starts running, only trigger once, no arguments,
+ });
- hook.beforeEach(function(content) {
- // Invoked each time before parsing the Markdown file.
- // ...
- return content
- })
+ hook.beforeEach(function(content) {
+ // Invoked each time before parsing the Markdown file.
+ // ...
+ return content;
+ });
- hook.afterEach(function(html, next) {
- // Invoked each time after the Markdown file is parsed.
- // beforeEach and afterEach support asynchronousγ
- // ...
- // call `next(html)` when task is done.
- next(html)
- })
+ hook.afterEach(function(html, next) {
+ // Invoked each time after the Markdown file is parsed.
+ // beforeEach and afterEach support asynchronousγ
+ // ...
+ // call `next(html)` when task is done.
+ next(html);
+ });
- hook.doneEach(function() {
- // Invoked each time after the data is fully loaded, no arguments,
- // ...
- })
+ hook.doneEach(function() {
+ // Invoked each time after the data is fully loaded, no arguments,
+ // ...
+ });
- hook.mounted(function() {
- // Called after initial completion. Only trigger once, no arguments.
- })
+ hook.mounted(function() {
+ // Called after initial completion. Only trigger once, no arguments.
+ });
- hook.ready(function() {
- // Called after initial completion, no arguments.
- })
- }
- ]
-}
+ hook.ready(function() {
+ // Called after initial completion, no arguments.
+ });
+ }
+ ]
+};
```
!> You can get internal methods through `window.Docsify`. Get the current instance through the second argument.
@@ -54,21 +54,21 @@ Add footer component in each pages.
```js
window.$docsify = {
plugins: [
- function (hook) {
+ function(hook) {
var footer = [
'loading
+
+
diff --git a/index.html b/index.html
index f15433b..59e6911 100644
--- a/index.html
+++ b/index.html
@@ -21,48 +21,64 @@
+
+
+
+