Skip to content

Commit

Permalink
feat: add docsify-updated, close #158
Browse files Browse the repository at this point in the history
  • Loading branch information
QingWei-Li committed May 16, 2017
1 parent ca0d618 commit d2be5ae
Show file tree
Hide file tree
Showing 11 changed files with 95 additions and 13 deletions.
2 changes: 1 addition & 1 deletion app.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ var fs = require('fs')

http.createServer(function (req, res) {
serveStatic('.')(req, res, function () {
res.writeHead(404, { 'Content-Type': 'text/html' })
res.writeHead(200, { 'Content-Type': 'text/html' })
res.end(fs.readFileSync('dev.html'))
})
}).listen(3000, '0.0.0.0')
Expand Down
10 changes: 9 additions & 1 deletion dev.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,15 @@
loadSidebar: true,
name: 'docsify',
subMaxLevel: 2,
mergeNavbar: true
mergeNavbar: true,
formatUpdated: '{MM}/{DD} {HH}:{mm}',
plugins: [
function(hook) {
hook.beforeEach(function (html) {
return html += '> Last modified {docsify-updated}'
})
}
]
}
</script>
<script src="/lib/docsify.js"></script>
Expand Down
15 changes: 15 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,3 +315,18 @@ window.$docsify = {
mergeNavbar: true
}
```

## format-updated
We can display the file update date through **{docsify-updated<span>}</span>** 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
}
}
```
17 changes: 16 additions & 1 deletion docs/de-de/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,4 +314,19 @@ Navbar will be merged with the sidebar on smaller screens.
window.$docsify = {
mergeNavbar: true
}
```
```

## format-updated
We can display the file update date through **{docsify-updated<span>}</span>** 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
}
}
```
10 changes: 9 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
loadNavbar: true,
mergeNavbar: true,
maxLevel: 4,
subMaxLevel: 2,
name: 'docsify',
search: {
noData: {
Expand All @@ -48,7 +49,14 @@
'/': 'Search'
}
},
subMaxLevel: 2
formatUpdated: '{MM}/{DD} {HH}:{mm}',
plugins: [
function(hook) {
hook.beforeEach(function (html) {
return html += '> Last modified {docsify-updated}'
})
}
]
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
Expand Down
14 changes: 14 additions & 0 deletions docs/zh-cn/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,3 +326,17 @@ window.$docsify = {
}
```

## format-updated
我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`.
参考 https://github.com/lukeed/tinydate#patterns
```js
window.$docsify = {
formatUpdated: '{MM}/{DD} {HH}:{mm}',

formatUpdated: function (time) {
// ...

return time
}
}
```
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"dependencies": {
"marked": "^0.3.6",
"prismjs": "^1.6.0",
"tinydate": "^1.0.0",
"zoom-image": "^0.1.4"
},
"devDependencies": {
Expand Down
3 changes: 2 additions & 1 deletion src/core/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ const config = merge({
executeScript: null,
noEmoji: false,
ga: '',
mergeNavbar: false
mergeNavbar: false,
formatUpdated: ''
}, window.$docsify)

const script = document.currentScript ||
Expand Down
15 changes: 11 additions & 4 deletions src/core/fetch/ajax.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ export function get (url, hasBar = false) {
const on = function () {
xhr.addEventListener.apply(xhr, arguments)
}
const cached = cache[url]

if (cache[url]) {
return { then: cb => cb(cache[url]), abort: noop }
if (cached) {
return { then: cb => cb(cached.content, cached.opt), abort: noop }
}

xhr.open('GET', url)
Expand All @@ -41,8 +42,14 @@ export function get (url, hasBar = false) {
if (target.status >= 400) {
error(target)
} else {
cache[url] = target.response
success(target.response)
const result = cache[url] = {
content: target.response,
opt: {
updatedAt: xhr.getResponseHeader('last-modified')
}
}

success(result.content, result.opt)
}
})
},
Expand Down
4 changes: 2 additions & 2 deletions src/core/fetch/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ export function fetchMixin (proto) {
this.isHTML = /\.html$/g.test(path)

// Load main content
last.then(text => {
this._renderMain(text)
last.then((text, opt) => {
this._renderMain(text, opt)
if (!loadSidebar) return cb()

const fn = result => { this._renderSidebar(result); cb() }
Expand Down
17 changes: 15 additions & 2 deletions src/core/render/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { callHook } from '../init/lifecycle'
import { getBasePath, getPath, isAbsolutePath } from '../route/util'
import { isPrimitive } from '../util/core'
import { isMobile } from '../util/env'
import tinydate from 'tinydate'

function executeScript () {
const script = dom.findAll('.markdown-section>script')
Expand All @@ -21,6 +22,16 @@ function executeScript () {
}, 0)
}

function formatUpdated (html, updated, fn) {
updated = typeof fn === 'function'
? fn(updated)
: typeof fn === 'string'
? tinydate(fn)(new Date(updated))
: updated

return html.replace(/{docsify-updated}/g, updated)
}

function renderMain (html) {
if (!html) {
// TODO: Custom 404 page
Expand Down Expand Up @@ -97,9 +108,11 @@ export function renderMixin (proto) {
getAndActive('nav')
}

proto._renderMain = function (text) {
proto._renderMain = function (text, opt) {
callHook(this, 'beforeEach', text, result => {
const html = this.isHTML ? result : markdown(result)
let html = this.isHTML ? result : markdown(result)
html = formatUpdated(html, opt.updatedAt, this.config.formatUpdated)

callHook(this, 'afterEach', html, text => renderMain.call(this, text))
})
}
Expand Down

0 comments on commit d2be5ae

Please sign in to comment.