From 97669e0d28081e89df573c8d89b24ebf5c5636fd Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Fri, 23 Dec 2016 09:25:30 +0800 Subject: [PATCH 1/5] Add similar projects into readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bceee7b87..6b15d722c 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,10 @@ These open-source projects are using docsify to generate their sites. Pull reque - [docsify](https://docsify.js.org) - A magical documentation site generator. - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity. +## Similar projects +- [docute](https://github.com/egoist/docute) - πŸ“œ Effortlessly documentation done right +- [docpress](https://github.com/docpress/docpress) - Documentation website generator + ## Contributing - Fork it! From d0861d74272fb6748f9daef0323fc0ad29df7377 Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Fri, 23 Dec 2016 21:46:12 +0800 Subject: [PATCH 2/5] Fixed cover rendering timing --- CHANGELOG.md | 4 ++++ docs/_coverpage.md | 2 +- src/index.js | 12 +++++------- src/render.js | 2 ++ 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b8be2e708..d9f63294e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 1.3.3 +### Bug fixes +- Fixed cover rendering timing + ## 1.3.2 ### Bug fixes diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 08945c427..92ba59261 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,6 +1,6 @@ ![logo](_media/icon.svg) -# docsify 1.3.2 +# docsify 1.3.3 > A magical documentation site generator. diff --git a/src/index.js b/src/index.js index 9d2ac9e9f..2ca7ead3a 100644 --- a/src/index.js +++ b/src/index.js @@ -59,12 +59,8 @@ const mainRender = function (cb) { } // Render Cover page - if (OPTIONS.coverpage) { - if (page === OPTIONS.homepage) { - load(OPTIONS.coverpage).then(render.renderCover) - } else { - render.renderCover() - } + if (OPTIONS.coverpage && page === OPTIONS.homepage) { + load(OPTIONS.coverpage).then(render.renderCover) } cacheXhr && cacheXhr.abort && cacheXhr.abort() @@ -72,6 +68,9 @@ const mainRender = function (cb) { cacheXhr = load(page, 'GET', render.renderLoading) cacheXhr.then(result => { render.renderArticle(result) + // clear cover + if (OPTIONS.coverpage && page !== OPTIONS.homepage) render.renderCover() + // render sidebar if (OPTIONS.loadSidebar) { if (wait === false) cb() wait = false @@ -102,7 +101,6 @@ const Docsify = function () { mainRender(_ => { activeLink('aside.sidebar', true) scrollIntoView() - OPTIONS.coverpage && sticky() }) } diff --git a/src/render.js b/src/render.js index 987269540..c021d0796 100644 --- a/src/render.js +++ b/src/render.js @@ -132,6 +132,8 @@ export function renderCover (content) { !renderCover.rendered && renderTo('.cover-main', marked(content)) renderCover.rendered = true } + + sticky() } /** From 668c5ca714bdffce1b4f22d2dce19f06f8a01cd5 Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Fri, 23 Dec 2016 21:47:15 +0800 Subject: [PATCH 3/5] fix lint --- src/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/index.js b/src/index.js index 2ca7ead3a..ba776a2aa 100644 --- a/src/index.js +++ b/src/index.js @@ -1,5 +1,5 @@ import { load, camel2kebab, isNil, getRoute } from './util' -import { activeLink, scrollIntoView, sticky } from './event' +import { activeLink, scrollIntoView } from './event' import * as render from './render' const OPTIONS = { From 16623c9301a6f2fdc6927e9e916b8a926b66f2b5 Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Fri, 23 Dec 2016 21:47:31 +0800 Subject: [PATCH 4/5] bump 1.3.3 --- lib/docsify.js | 14 +++++++------- lib/docsify.min.js | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/docsify.js b/lib/docsify.js index cd71240fe..26a9b027a 100644 --- a/lib/docsify.js +++ b/lib/docsify.js @@ -2506,6 +2506,8 @@ function renderCover (content) { !renderCover.rendered && renderTo('.cover-main', marked(content)); renderCover.rendered = true; } + + sticky(); } /** @@ -2610,12 +2612,8 @@ var mainRender = function (cb) { } // Render Cover page - if (OPTIONS.coverpage) { - if (page === OPTIONS.homepage) { - load(OPTIONS.coverpage).then(renderCover); - } else { - renderCover(); - } + if (OPTIONS.coverpage && page === OPTIONS.homepage) { + load(OPTIONS.coverpage).then(renderCover); } cacheXhr && cacheXhr.abort && cacheXhr.abort(); @@ -2623,6 +2621,9 @@ var mainRender = function (cb) { cacheXhr = load(page, 'GET', renderLoading); cacheXhr.then(function (result) { renderArticle(result); + // clear cover + if (OPTIONS.coverpage && page !== OPTIONS.homepage) { renderCover(); } + // render sidebar if (OPTIONS.loadSidebar) { if (wait === false) { cb(); } wait = false; @@ -2653,7 +2654,6 @@ var Docsify = function () { mainRender(function (_) { activeLink('aside.sidebar', true); scrollIntoView(); - OPTIONS.coverpage && sticky(); }); }; diff --git a/lib/docsify.min.js b/lib/docsify.min.js index 45edcf06f..bb2f6d7ed 100644 --- a/lib/docsify.min.js +++ b/lib/docsify.min.js @@ -1,2 +1,2 @@ -var Docsify=function(){"use strict";function e(e,t,n){void 0===t&&(t="GET");var r=new XMLHttpRequest;return r.open(t,e),r.send(),{then:function(e,t){if(void 0===t&&(t=function(){}),n){var i=setInterval(function(e){return n({step:Math.floor(5*Math.random()+1)})},500);r.addEventListener("progress",n),r.addEventListener("loadend",function(e){n(e),clearInterval(i)})}r.addEventListener("error",t),r.addEventListener("load",function(n){var r=n.target;r.status>=400?t(r):e(r.response)})},abort:function(){return 4!==r.readyState&&r.abort()}}}function t(e,t){var n=[],r={};return e.forEach(function(e){var i=e.level||1,a=i-1;i>t||(r[a]?(r[a].children=r[a].children||[],r[a].children.push(e)):n.push(e),r[i]=e)}),n}function n(e){return e.replace(/([A-Z])/g,function(e){return"-"+e.toLowerCase()})}function r(e){return null===e||void 0===e}function i(){var e=window.location;if(A===e.hash&&!r(C))return C;var t=e.hash.match(/^#\/([^#]+)/);return t=t&&2===t.length?t[1]:/^#\//.test(e.hash)?"":e.pathname,C=t,A=e.hash,t}function a(){return document.body.clientWidth<=600}function s(){function e(){for(var e=0,r=t.length;e10){var o=n[a.getAttribute("data-id")];if(!o||o===i)return;return i&&i.setAttribute("class",""),o.setAttribute("class","active"),void(i=o)}}}if(!a()){for(var t=document.querySelectorAll(".anchor"),n={},r=document.querySelectorAll(".sidebar li"),i=null,s=0,o=r.length;s=t||e.classList.contains("hidden")?document.body.classList.add("sticky"):document.body.classList.remove("sticky")}()}function p(e,t){return t={exports:{}},e(t,t.exports),t.exports}function g(e){return e?(/\/\//.test(e)||(e="https://github.com/"+e),e=e.replace(/^git\+/,""),'\n \n \n '):""}function h(e){return"
\n "+e+'\n \n
\n
\n
\n
'}function f(){var e=", 100%, 85%",t="linear-gradient(to left bottom, hsl("+(Math.floor(255*Math.random())+e)+") 0%, hsl("+(Math.floor(255*Math.random())+e)+") 100%)";return'
\n
\n
'}function m(){return''}function b(e,t){return void 0===t&&(t=""),e&&e.length?(e.forEach(function(e){t+='
  • '+e.title+"
    • ",e.children&&(t+='
    • '+b(e.children)+"
    ")}),t):""}function y(e,t){var n=document.querySelector("nav")||document.createElement("nav");j.repo||n.classList.add("no-badge"),e[t?"outerHTML":"innerHTML"]=g(j.repo)+(j.coverpage?f():"")+h(j.sidebarToggle?m():""),document.body.insertBefore(n,document.body.children[0]),u("button.sidebar-toggle"),j.coverpage?!a()&&window.addEventListener("scroll",d):document.body.classList.add("sticky")}function v(e){N("article",e?E(e):"not found"),x.rendered||x(null,j),k.rendered||k(null,j),x.rendered=!1,k.rendered=!1,j.auto2top&&c()}function k(e){T.navbar&&T.navbar===e||(T.navbar=e,k.rendered=!0,e&&N("nav",E(e)),l("nav"))}function x(e){var n=!1;e?e=E(e):j.sidebar?e=b(j.sidebar,"