refactor(core): add render

This commit is contained in:
qingwei.li 2017-02-17 23:09:09 +08:00 • committed by cinwell.li
commit 8bee8f0213
20 changed files with 232 additions and 102 deletions

View file

@ -24,7 +24,7 @@
- Smart full-text search plugin - Smart full-text search plugin
- Multiple themes - Multiple themes
- Useful plugin API - Useful plugin API
- Compatible with IE9+ - Compatible with IE10+
## Quick start ## Quick start
Create a `index.html`. Create a `index.html`.

View file

@ -27,34 +27,39 @@ var build = function (opts) {
} }
build({ build({
entry: 'index.js', entry: 'core/index.js',
output: 'docsify.js', output: 'docsify.js',
plugins: [commonjs(), nodeResolve()] plugins: [commonjs(), nodeResolve()]
}) })
isProd && build({
// build({
// entry: 'plugins/search.js',
// output: 'plugins/search.js',
// moduleName: 'D.Search'
// })
// build({
// entry: 'plugins/ga.js',
// output: 'plugins/ga.js',
// moduleName: 'D.GA'
// })
if (isProd) {
build({
entry: 'index.js', entry: 'index.js',
output: 'docsify.min.js', output: 'docsify.min.js',
plugins: [commonjs(), nodeResolve(), uglify()] plugins: [commonjs(), nodeResolve(), uglify()]
}) })
build({ build({
entry: 'plugins/search.js',
output: 'plugins/search.js',
moduleName: 'D.Search'
})
isProd && build({
entry: 'plugins/search.js', entry: 'plugins/search.js',
output: 'plugins/search.min.js', output: 'plugins/search.min.js',
moduleName: 'D.Search', moduleName: 'D.Search',
plugins: [uglify()] plugins: [uglify()]
}) })
build({ build({
entry: 'plugins/ga.js',
output: 'plugins/ga.js',
moduleName: 'D.GA'
})
isProd && build({
entry: 'plugins/ga.js', entry: 'plugins/ga.js',
output: 'plugins/ga.min.js', output: 'plugins/ga.min.js',
moduleName: 'D.GA', moduleName: 'D.GA',
plugins: [uglify()] plugins: [uglify()]
}) })
}

View file

@ -15,7 +15,7 @@ See the [Quick start](/quickstart) for more details.
- Smart full-text search plugin - Smart full-text search plugin
- Multiple themes - Multiple themes
- Useful plugin API - Useful plugin API
- Compatible with IE9+ - Compatible with IE10+
## Examples ## Examples

View file

@ -16,7 +16,7 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo
- 智能的全文搜索 - 智能的全文搜索
- 提供多套主题 - 提供多套主题
- 丰富的 API - 丰富的 API
- 兼容 IE9+ - 兼容 IE10+
## 例子 ## 例子

View file

@ -17,7 +17,9 @@ const config = merge({
ga: '' ga: ''
}, window.$docsify) }, window.$docsify)
const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop() const script = document.currentScript ||
[].slice.call(document.getElementsByTagName('script'))
.filter(n => /docsify\./.test(n.src))[0]
if (script) { if (script) {
for (const prop in config) { for (const prop in config) {

View file

@ -1,11 +1,19 @@
export function eventMixin (Docsify) { import { isMobile } from '../util/env'
Docsify.prototype.$bindEvents = function () { import { dom, on } from '../util/dom'
} import * as sidebar from './sidebar'
export function eventMixin (Docsify) {
Docsify.prototype.$resetEvents = function () { Docsify.prototype.$resetEvents = function () {
} }
} }
export function initEvent (vm) { export function initEvent (vm) {
vm.$bindEvents() // Bind toggle button
sidebar.btn('button.sidebar-toggle')
// Bind sticky effect
if (vm.config.coverpage) {
!isMobile && on('scroll', sidebar.sticky)
} else {
dom.body.classList.add('sticky')
}
} }

10
src/core/event/scroll.js Normal file
View file

@ -0,0 +1,10 @@
export function activeSidebar () {
}
export function scrollIntoView () {
}
export function scroll2Top () {
}

28
src/core/event/sidebar.js Normal file
View file

@ -0,0 +1,28 @@
import { isMobile } from '../util/env'
import { getNode, on, dom } from '../util/dom'
/**
* Toggle button
*/
export function btn (el) {
const toggle = () => dom.body.classList.toggle('close')
el = getNode(el)
on(el, 'click', toggle)
if (isMobile) {
const sidebar = getNode('.sidebar')
on(sidebar, 'click', () => {
toggle()
setTimeout(() => activeLink(sidebar, true), 0)
})
}
}
export function sticky () {
}
export function activeLink () {
}

View file

@ -1,7 +1,8 @@
import { callHook } from '../init/lifecycle' import { callHook } from '../init/lifecycle'
export function fetchMixin (Docsify) { export function fetchMixin (Docsify) {
Docsify.prototype.$fetch = function () { Docsify.prototype.$fetch = function (path) {
// 加载侧边栏、导航、内容
} }
} }

View file

@ -9,7 +9,7 @@ import { isFn } from '../util/core'
export function initMixin (Docsify) { export function initMixin (Docsify) {
Docsify.prototype._init = function () { Docsify.prototype._init = function () {
const vm = this const vm = this
vm._config = config || {} vm.config = config || {}
initLifecycle(vm) // Init hooks initLifecycle(vm) // Init hooks
initPlugin(vm) // Install plugins initPlugin(vm) // Install plugins
@ -23,5 +23,5 @@ export function initMixin (Docsify) {
} }
function initPlugin (vm) { function initPlugin (vm) {
[].concat(vm.config.plugins).forEach(fn => isFn(fn) && fn(vm.bindHook)) [].concat(vm.config.plugins).forEach(fn => isFn(fn) && fn(vm._lifecycle, vm))
} }

View file

@ -4,10 +4,10 @@ export function initLifecycle (vm) {
const hooks = ['init', 'beforeEach', 'afterEach', 'doneEach', 'ready'] const hooks = ['init', 'beforeEach', 'afterEach', 'doneEach', 'ready']
vm._hooks = {} vm._hooks = {}
vm.bindHook = {} vm._lifecycle = {}
hooks.forEach(hook => { hooks.forEach(hook => {
const arr = vm._hooks[hook] = [] const arr = vm._hooks[hook] = []
vm._bindHook[hook] = fn => arr.push(fn) vm._lifecycle[hook] = fn => arr.push(fn)
}) })
} }

View file

@ -1,12 +0,0 @@
const cacheNode = {}
export function getCacheNode (el) {
if (typeof el === 'string') {
const selector = el
el = cacheNode[el] || document.querySelector(el)
if (!el) console.error('Cannot find element:', selector)
}
return el
}

View file

@ -1,9 +1,47 @@
export function renderMixin (Docsify) { import { getNode, dom } from '../util/dom'
Docsify.prototype._renderTo = function (dom, content) { import cssVars from '../util/polyfill/css-vars'
import * as tpl from './tpl'
export function renderMixin (Docsify) {
Docsify.prototype._renderTo = function (el, content, replace) {
const node = getNode(el)
if (node) node[replace ? 'outerHTML' : 'innerHTML'] = content
} }
} }
export function initRender (vm) { export function initRender (vm) {
// init const config = vm.config
const id = config.el || '#app'
const navEl = dom.find('nav') || dom.create('nav')
let el = dom.find(id)
let html = ''
navEl.classList.add('app-nav')
if (!config.repo) {
navEl.classList.add('no-badge')
}
if (!el) {
el = dom.create(id)
dom.appendTo(dom.body, el)
}
if (config.repo) {
html += tpl.corner(config.repo)
}
if (config.coverpage) {
html += tpl.cover()
}
html += tpl.main(config)
// Render main app
vm._renderTo(el, html, true)
// Add nav
dom.body.insertBefore(navEl, dom.body.children[0])
if (config.themeColor) {
dom.head += tpl.theme(config.themeColor)
// Polyfll
cssVars(config.themeColor)
}
} }

View file

@ -1,3 +1,4 @@
import { dom } from '../util/dom'
import { isPrimitive } from '../util/core' import { isPrimitive } from '../util/core'
let loadingEl let loadingEl
@ -8,10 +9,10 @@ let timeId
*/ */
function init () { function init () {
if (loadingEl) return if (loadingEl) return
const div = document.createElement('div') const div = dom.create('div')
div.classList.add('progress') div.classList.add('progress')
document.body.appendChild(div) dom.appendTo(div, dom.body)
loadingEl = div loadingEl = div
} }
/** /**

View file

@ -1,4 +1,4 @@
import { isMobile } from '../util/core' import { isMobile } from '../util/env'
/** /**
* Render github corner * Render github corner
* @param {Object} data * @param {Object} data
@ -9,27 +9,38 @@ export function corner (data) {
if (!/\/\//.test(data)) data = 'https://github.com/' + data if (!/\/\//.test(data)) data = 'https://github.com/' + data
data = data.replace(/^git\+/, '') data = data.replace(/^git\+/, '')
return ` return (
<a href="${data}" class="github-corner" aria-label="View source on Github"> '<a href="${data}" class="github-corner" aria-label="View source on Github">' +
<svg viewBox="0 0 250 250" aria-hidden="true"> '<svg viewBox="0 0 250 250" aria-hidden="true">' +
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path> '<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>' +
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path> '<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>' +
<path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path> '<path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>' +
</svg> '</svg>' +
</a>` '</a>`')
} }
/** /**
* Render main content * Render main content
*/ */
export function main () { export function main (config) {
const aside = `${toggle()}<aside class="sidebar"><div class="sidebar-nav"></div></aside>` const aside = (
'<button class="sidebar-toggle">' +
'<div class="sidebar-toggle-button">' +
'<span></span><span></span><span></span>' +
'</div>' +
'</button>' +
'<aside class="sidebar">' +
(config.name
? `<h1><a href="${config.nameLink}">${config.name}</a></h1>`
: '') +
'<div class="sidebar-nav"></div>' +
'</aside>')
return (isMobile() ? `${aside}<main>` : `<main>${aside}`) + return (isMobile ? `${aside}<main>` : `<main>${aside}`) +
`<section class="content"> '<section class="content">' +
<article class="markdown-section"></article> '<article class="markdown-section"></article>' +
</section> '</section>' +
</main>` '</main>'
} }
/** /**
@ -37,20 +48,14 @@ export function main () {
*/ */
export function cover () { export function cover () {
const SL = ', 100%, 85%' const SL = ', 100%, 85%'
const bgc = `linear-gradient(to left bottom, hsl(${Math.floor(Math.random() * 255) + SL}) 0%, hsl(${Math.floor(Math.random() * 255) + SL}) 100%)` const bgc = 'linear-gradient(to left bottom, ' +
`hsl(${Math.floor(Math.random() * 255) + SL}) 0%,` +
`hsl(${Math.floor(Math.random() * 255) + SL}) 100%)`
return `<section class="cover" style="background: ${bgc}"> return `<section class="cover" style="background: ${bgc}">` +
<div class="cover-main"></div> '<div class="cover-main"></div>' +
<div class="mask"></div> '<div class="mask"></div>' +
</section>` '</section>'
}
export function toggle () {
return `<button class="sidebar-toggle">
<div class="sidebar-toggle-button">
<span></span><span></span><span></span>
</div>
</button>`
} }
/** /**

View file

@ -1,5 +1,4 @@
import { cleanPath, getLocation } from './util' // import { cleanPath, getLocation } from './util'
export function ensureSlash () { export function ensureSlash () {
const path = getHash() const path = getHash()
if (path.charAt(0) === '/') return if (path.charAt(0) === '/') return

41
src/core/util/dom.js Normal file
View file

@ -0,0 +1,41 @@
import { isFn } from '../util/core'
const cacheNode = {}
/**
* Get Node
* @param {String|Element} el
* @param {Boolean} noCache
* @return {Element}
*/
export function getNode (el, noCache = false) {
if (typeof el === 'string') {
el = noCache ? dom.find(el) : (cacheNode[el] || dom.find(el))
}
return el
}
export const dom = {
body: document.body,
head: document.head,
find: node => document.querySelector(node),
findAll: node => document.querySelectorAll(node),
create: (node, tpl) => {
node = document.createElement(node)
if (tpl) node.innerHTML = tpl
},
appendTo: (target, el) => target.appendChild(el)
}
export function on (el, type, handler) {
isFn(type)
? window.addEventListener(el, type)
: el.addEventListener(type, handler)
}
export const off = function on (el, type, handler) {
isFn(type)
? window.removeEventListener(el, type)
: el.removeEventListener(type, handler)
}

View file

@ -1,2 +1,3 @@
export * from './core' export * from './core'
export * from './env' export * from './env'
export * from './dom'

View file

@ -1,29 +1,32 @@
import { get } from '../fetch/ajax' import { dom } from '../dom'
import { get } from '../../fetch/ajax'
function replaceVar (block) { function replaceVar (block, themeColor) {
block.innerHTML = block.innerHTML.replace(/var\(\s*--theme-color.*?\)/g, $docsify.themeColor) block.innerHTML = block.innerHTML
.replace(/var\(\s*--theme-color.*?\)/g, themeColor)
} }
export function cssVars () { export default function (themeColor) {
// variable support // Variable support
if (window.CSS && window.CSS.supports && window.CSS.supports('(--foo: red)')) return if (window.CSS
&& window.CSS.supports
&& window.CSS.supports('(--foo: red)')) return
const styleBlocks = document.querySelectorAll('style:not(.inserted),link') const styleBlocks = dom.findAll('style:not(.inserted),link')
;[].forEach.call(styleBlocks, block => { ;[].forEach.call(styleBlocks, block => {
if (block.nodeName === 'STYLE') { if (block.nodeName === 'STYLE') {
replaceVar(block) replaceVar(block, themeColor)
} else if (block.nodeName === 'LINK') { } else if (block.nodeName === 'LINK') {
const href = block.getAttribute('href') const href = block.getAttribute('href')
if (!/\.css$/.test(href)) return if (!/\.css$/.test(href)) return
get(href).then(res => { get(href).then(res => {
const style = document.createElement('style') const style = dom.create('style', res)
style.innerHTML = res dom.head.appendChild(style)
document.head.appendChild(style) replaceVar(style, themeColor)
replaceVar(style)
}) })
} }
}) })

View file

@ -64,7 +64,7 @@ kbd {
} }
/* navbar */ /* navbar */
nav { nav.app-nav {
position: absolute; position: absolute;
right: 0; right: 0;
left: 0; left: 0;