Compare commits

...
8 Commits
Author SHA1 Message Date
Qingwei Li a257a4ab4e chore: add changelog 4.8.6 2018-11-12 10:24:23 +08:00
Qingwei Li a07a613312 [build] 4.8.6 2018-11-12 10:24:21 +08:00
程康andcinwell.li 4db8cd6abf fix: IE10 compatibility (#691)
* fix: IE10 compatibility

* chore: use built-in helper fn
2018-11-12 10:22:14 +08:00
Li Yimingandcinwell.li a72e7490c3 docs: mermaid duplicated id, see #504 (#685)
Please makes sure these boxes are checked before submitting your PR, thank you!

* [x] Make sure you are merging your commits to `master` branch.
* [x] Add some descriptions and refer relative issues for you PR.
* [x] DO NOT include files inside `lib` directory.
2018-11-06 17:27:24 +08:00
qingwei.li cc79e2e992 chore: add changelog 4.8.5 2018-11-02 08:59:35 +08:00
qingwei.li 5b6525b8f1 [build] 4.8.5 2018-11-02 08:59:34 +08:00
qingwei.li aa719e3a47 fix: expose version info for Docsify, fixed #641 2018-11-02 08:53:46 +08:00
qingwei.li 22a5927eaf docs(helper): about markdown in html tag, fixed #655 fixed #667 2018-11-02 07:38:54 +08:00
17 changed files with 155 additions and 71 deletions
+20
View File
@@ -1,3 +1,23 @@
<a name="4.8.6"></a>
## [4.8.6](https://github.com/docsifyjs/docsify/compare/v4.8.5...v4.8.6) (2018-11-12)
### Bug Fixes
* IE10 compatibility ([#691](https://github.com/docsifyjs/docsify/issues/691)) ([4db8cd6](https://github.com/docsifyjs/docsify/commit/4db8cd6))
<a name="4.8.5"></a>
## [4.8.5](https://github.com/docsifyjs/docsify/compare/v4.8.4...v4.8.5) (2018-11-02)
### Bug Fixes
* expose version info for Docsify, fixed [#641](https://github.com/docsifyjs/docsify/issues/641) ([aa719e3](https://github.com/docsifyjs/docsify/commit/aa719e3))
<a name="4.8.4"></a>
## [4.8.4](https://github.com/docsifyjs/docsify/compare/v4.8.3...v4.8.4) (2018-11-01)
+1 -1
View File
@@ -1,6 +1,6 @@
![logo](_media/icon.svg)
# docsify <small>4.8.4</small>
# docsify <small>4.8.6</small>
> A magical documentation site generator.
+44 -1
View File
@@ -88,6 +88,7 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
![logo](https://docsify.js.org/_media/icon.svg ':size=100')
<!-- Support percentage -->
![logo](https://docsify.js.org/_media/icon.svg ':size=10%')
```
@@ -99,4 +100,46 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
```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
<details>
<summary>Self-assessment (Click to expand)</summary>
- Abc
- Abc
</details>
```
<details>
<summary>Self-assessment (Click to expand)</summary>
- Abc
- Abc
</details>
Or markdown content can be wrapped in html tag.
```markdown
<div style='color: red'>
- listitem
- listitem
- listitem
</div>
```
<div style='color: red'>
- Abc
- Abc
</div>
+2 -1
View File
@@ -36,6 +36,7 @@ window.$docsify = {
// <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
// <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
var num = 0;
mermaid.initialize({ startOnLoad: false });
window.$docsify = {
@@ -44,7 +45,7 @@ window.$docsify = {
code: function(code, lang) {
if (lang === "mermaid") {
return (
'<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
'<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + "</div>"
);
}
return this.origin.code.apply(this, arguments);
+64 -46
View File
@@ -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 = [
'<hr/>',
'<footer>',
'<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
'<span>Proudly published with <a href="https://github.com/docsifyjs/docsify" target="_blank">docsify</a>.</span>',
'</footer>'
].join('')
].join('');
hook.afterEach(function (html) {
return html + footer
})
hook.afterEach(function(html) {
return html + footer;
});
}
]
}
};
```
### Edit Button
@@ -77,17 +77,35 @@ window.$docsify = {
window.$docsify = {
plugins: [
function(hook, vm) {
hook.beforeEach(function (html) {
var url = 'https://github.com/docsifyjs/docsify/blob/master/docs' + vm.route.file
var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n'
hook.beforeEach(function(html) {
var url =
'https://github.com/docsifyjs/docsify/blob/master/docs' +
vm.route.file;
var editHtml = '[📝 EDIT DOCUMENT](' + url + ')\n';
return editHtml
+ html
+ '\n----\n'
+ 'Last modified {docsify-updated} '
+ editHtml
})
return (
editHtml +
html +
'\n----\n' +
'Last modified {docsify-updated} ' +
editHtml
);
});
}
]
}
};
```
## Tips
### Get docsify version
```
console.log(window.Docsify.version)
```
Current version: <span id='tip-version'>loading</span>
<script>
document.getElementById('tip-version').innerText = Docsify.version
</script>
+8 -7
View File
@@ -3571,7 +3571,7 @@ Compiler.prototype._initRenderer = function _initRenderer () {
}
href = router.toURL(href, null, router.getCurrentPath());
} else {
attrs += href.startsWith('mailto:') ? '' : (" target=\"" + linkTarget + "\"");
attrs += href.indexOf('mailto:') === 0 ? '' : (" target=\"" + linkTarget + "\"");
}
if (config.target) {
@@ -5008,7 +5008,13 @@ var util = Object.freeze({
});
function initGlobalAPI () {
window.Docsify = {util: util, dom: dom, get: get, slugify: slugify};
window.Docsify = {
util: util,
dom: dom,
get: get,
slugify: slugify,
version: '4.8.6'
};
window.DocsifyCompiler = Compiler;
window.marked = marked;
window.Prism = prism;
@@ -5044,11 +5050,6 @@ eventMixin(proto);
*/
initGlobalAPI();
/**
* Version
*/
Docsify.version = '4.8.4';
/**
* Run Docsify
*/
+1 -1
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -17,7 +17,7 @@ function escapeHtml(string) {
function getAllPaths(router) {
var paths = [];
document.querySelectorAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(function (node) {
Docsify.dom.findAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(function (node) {
var href = node.href;
var originHref = node.getAttribute('href');
var path = router.parse(href).path;
+1 -1
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "docsify",
"version": "4.8.4",
"version": "4.8.6",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "docsify",
"version": "4.8.4",
"version": "4.8.6",
"description": "A magical documentation generator.",
"author": {
"name": "qingwei-li",
+1 -1
View File
@@ -37,5 +37,5 @@
"integrity": "sha1-6DWIAbhrg7F1YNTjw4LXrvIQCUQ="
}
},
"version": "4.8.4"
"version": "4.8.6"
}
@@ -1,6 +1,6 @@
{
"name": "docsify-server-renderer",
"version": "4.8.4",
"version": "4.8.6",
"description": "docsify server renderer",
"author": {
"name": "qingwei-li",
+7 -1
View File
@@ -7,7 +7,13 @@ import marked from 'marked'
import prism from 'prismjs'
export default function () {
window.Docsify = {util, dom, get, slugify}
window.Docsify = {
util,
dom,
get,
slugify,
version: '__VERSION__'
}
window.DocsifyCompiler = Compiler
window.marked = marked
window.Prism = prism
-5
View File
@@ -35,11 +35,6 @@ eventMixin(proto)
*/
initGlobalAPI()
/**
* Version
*/
Docsify.version = '__VERSION__'
/**
* Run Docsify
*/
+1 -1
View File
@@ -241,7 +241,7 @@ export class Compiler {
}
href = router.toURL(href, null, router.getCurrentPath())
} else {
attrs += href.startsWith('mailto:') ? '' : ` target="${linkTarget}"`
attrs += href.indexOf('mailto:') === 0 ? '' : ` target="${linkTarget}"`
}
if (config.target) {
+1 -1
View File
@@ -16,7 +16,7 @@ function escapeHtml(string) {
function getAllPaths(router) {
const paths = []
document.querySelectorAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(node => {
Docsify.dom.findAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(node => {
const href = node.href
const originHref = node.getAttribute('href')
const path = router.parse(href).path