mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
refactor(core): adjust directory structure:
This commit is contained in:
parent
e07d36f44e
commit
aad62b65f5
38
src/core/config.js
Normal file
38
src/core/config.js
Normal file
@ -0,0 +1,38 @@
|
||||
import { merge, camelize, isPrimitive } from './util/core'
|
||||
|
||||
const config = merge({
|
||||
el: '#app',
|
||||
repo: '',
|
||||
maxLevel: 6,
|
||||
subMaxLevel: 0,
|
||||
loadSidebar: null,
|
||||
loadNavbar: null,
|
||||
homepage: 'README.md',
|
||||
coverpage: '',
|
||||
basePath: '',
|
||||
auto2top: false,
|
||||
name: '',
|
||||
themeColor: '',
|
||||
nameLink: window.location.pathname,
|
||||
ga: ''
|
||||
}, window.$docsify)
|
||||
|
||||
const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()
|
||||
|
||||
if (script) {
|
||||
for (const prop in config) {
|
||||
const val = script.getAttribute('data-' + camelize(prop))
|
||||
|
||||
if (isPrimitive(val)) {
|
||||
config[prop] = val === '' ? true : val
|
||||
}
|
||||
}
|
||||
|
||||
if (config.loadSidebar === true) config.loadSidebar = '_sidebar.md'
|
||||
if (config.loadNavbar === true) config.loadNavbar = '_navbar.md'
|
||||
if (config.coverpage === true) config.coverpage = '_coverpage.md'
|
||||
if (config.repo === true) config.repo = ''
|
||||
if (config.name === true) config.name = ''
|
||||
}
|
||||
|
||||
export default config
|
||||
11
src/core/event/index.js
Normal file
11
src/core/event/index.js
Normal file
@ -0,0 +1,11 @@
|
||||
export function eventMixin (Docsify) {
|
||||
Docsify.prototype.$bindEvents = function () {
|
||||
}
|
||||
|
||||
Docsify.prototype.$resetEvents = function () {
|
||||
}
|
||||
}
|
||||
|
||||
export function initEvent (vm) {
|
||||
vm.$bindEvents()
|
||||
}
|
||||
37
src/core/fetch/ajax.js
Normal file
37
src/core/fetch/ajax.js
Normal file
@ -0,0 +1,37 @@
|
||||
import progressbar from '../render/progressbar'
|
||||
import { noop } from '../util/core'
|
||||
|
||||
/**
|
||||
* Simple ajax get
|
||||
* @param {String} url
|
||||
* @param {Boolean} [loading=false] has loading bar
|
||||
* @return { then(resolve, reject), abort }
|
||||
*/
|
||||
export function get (url, hasLoading = false) {
|
||||
const xhr = new XMLHttpRequest()
|
||||
|
||||
xhr.open('GET', url)
|
||||
xhr.send()
|
||||
|
||||
return {
|
||||
then: function (success, error = noop) {
|
||||
const on = xhr.addEventListener
|
||||
|
||||
if (hasLoading) {
|
||||
const id = setInterval(_ => progressbar({}), 500)
|
||||
|
||||
on('progress', progressbar)
|
||||
on('loadend', evt => {
|
||||
progressbar(evt)
|
||||
clearInterval(id)
|
||||
})
|
||||
}
|
||||
|
||||
on('error', error)
|
||||
on('load', ({ target }) => {
|
||||
target.status >= 400 ? error(target) : success(target.response)
|
||||
})
|
||||
},
|
||||
abort: () => xhr.readyState !== 4 && xhr.abort()
|
||||
}
|
||||
}
|
||||
13
src/core/fetch/index.js
Normal file
13
src/core/fetch/index.js
Normal file
@ -0,0 +1,13 @@
|
||||
import { callHook } from '../init/lifecycle'
|
||||
|
||||
export function fetchMixin (Docsify) {
|
||||
Docsify.prototype.$fetch = function () {
|
||||
}
|
||||
}
|
||||
|
||||
export function initFetch (vm) {
|
||||
vm.$fetch(result => {
|
||||
vm.$resetEvents()
|
||||
callHook(vm, 'doneEach')
|
||||
})
|
||||
}
|
||||
30
src/core/index.js
Normal file
30
src/core/index.js
Normal file
@ -0,0 +1,30 @@
|
||||
import { initMixin } from './init'
|
||||
import { routeMixin } from './route'
|
||||
import { renderMixin } from './render'
|
||||
import { fetchMixin } from './fetch'
|
||||
import { eventMixin } from './event'
|
||||
import * as util from './util'
|
||||
import { get as load } from './fetch/ajax'
|
||||
import * as routeUtil from './route/util'
|
||||
|
||||
function Docsify () {
|
||||
this._init()
|
||||
}
|
||||
|
||||
initMixin(Docsify)
|
||||
routeMixin(Docsify)
|
||||
renderMixin(Docsify)
|
||||
fetchMixin(Docsify)
|
||||
eventMixin(Docsify)
|
||||
|
||||
/**
|
||||
* Global API
|
||||
*/
|
||||
window.Docsify = {
|
||||
util: util.merge({ load }, util, routeUtil)
|
||||
}
|
||||
|
||||
/**
|
||||
* Run Docsify
|
||||
*/
|
||||
setTimeout(() => new Docsify(), 0)
|
||||
27
src/core/init/index.js
Normal file
27
src/core/init/index.js
Normal file
@ -0,0 +1,27 @@
|
||||
import config from '../config'
|
||||
import { initLifecycle, callHook } from './lifecycle'
|
||||
import { initRender } from '../render'
|
||||
import { initRoute } from '../route'
|
||||
import { initEvent } from '../event'
|
||||
import { initFetch } from '../fetch'
|
||||
import { isFn } from '../util/core'
|
||||
|
||||
export function initMixin (Docsify) {
|
||||
Docsify.prototype._init = function () {
|
||||
const vm = this
|
||||
vm._config = config || {}
|
||||
|
||||
initLifecycle(vm) // Init hooks
|
||||
initPlugin(vm) // Install plugins
|
||||
callHook(vm, 'init')
|
||||
initRender(vm) // Render base DOM
|
||||
initEvent(vm) // Bind events
|
||||
initRoute(vm) // Add hashchange eventListener
|
||||
initFetch(vm) // Fetch data
|
||||
callHook(vm, 'ready')
|
||||
}
|
||||
}
|
||||
|
||||
function initPlugin (vm) {
|
||||
[].concat(vm.config.plugins).forEach(fn => isFn(fn) && fn(vm.bindHook))
|
||||
}
|
||||
41
src/core/init/lifecycle.js
Normal file
41
src/core/init/lifecycle.js
Normal file
@ -0,0 +1,41 @@
|
||||
import { noop } from '../util/core'
|
||||
|
||||
export function initLifecycle (vm) {
|
||||
const hooks = ['init', 'beforeEach', 'afterEach', 'doneEach', 'ready']
|
||||
|
||||
vm._hooks = {}
|
||||
vm.bindHook = {}
|
||||
hooks.forEach(hook => {
|
||||
const arr = vm._hooks[hook] = []
|
||||
vm._bindHook[hook] = fn => arr.push(fn)
|
||||
})
|
||||
}
|
||||
|
||||
export function callHook (vm, hook, data, next = noop) {
|
||||
let newData = data
|
||||
const queue = vm._hooks[hook]
|
||||
|
||||
const step = function (index) {
|
||||
const hook = queue[index]
|
||||
if (index >= queue.length) {
|
||||
next(newData)
|
||||
} else {
|
||||
if (typeof hook === 'function') {
|
||||
if (hook.length === 2) {
|
||||
hook(data, result => {
|
||||
newData = result
|
||||
step(index + 1)
|
||||
})
|
||||
} else {
|
||||
const result = hook(data)
|
||||
newData = result !== undefined ? result : newData
|
||||
step(index + 1)
|
||||
}
|
||||
} else {
|
||||
step(index + 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
step(0)
|
||||
}
|
||||
12
src/core/render/dom.js
Normal file
12
src/core/render/dom.js
Normal file
@ -0,0 +1,12 @@
|
||||
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
|
||||
}
|
||||
9
src/core/render/index.js
Normal file
9
src/core/render/index.js
Normal file
@ -0,0 +1,9 @@
|
||||
export function renderMixin (Docsify) {
|
||||
Docsify.prototype._renderTo = function (dom, content) {
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
export function initRender (vm) {
|
||||
// init
|
||||
}
|
||||
45
src/core/render/progressbar.js
Normal file
45
src/core/render/progressbar.js
Normal file
@ -0,0 +1,45 @@
|
||||
import { isPrimitive } from '../util/core'
|
||||
|
||||
let loadingEl
|
||||
let timeId
|
||||
|
||||
/**
|
||||
* Init progress component
|
||||
*/
|
||||
function init () {
|
||||
if (loadingEl) return
|
||||
const div = document.createElement('div')
|
||||
|
||||
div.classList.add('progress')
|
||||
document.body.appendChild(div)
|
||||
loadingEl = div
|
||||
}
|
||||
/**
|
||||
* Render progress bar
|
||||
*/
|
||||
export default function ({ loaded, total, step }) {
|
||||
let num
|
||||
|
||||
loadingEl = init()
|
||||
|
||||
if (!isPrimitive(step)) {
|
||||
step = Math.floor(Math.random() * 5 + 1)
|
||||
}
|
||||
if (step) {
|
||||
num = parseInt(loadingEl.style.width, 10) + step
|
||||
num = num > 80 ? 80 : num
|
||||
} else {
|
||||
num = Math.floor(loaded / total * 100)
|
||||
}
|
||||
|
||||
loadingEl.style.opacity = 1
|
||||
loadingEl.style.width = num >= 95 ? '100%' : num + '%'
|
||||
|
||||
if (num >= 95) {
|
||||
clearTimeout(timeId)
|
||||
timeId = setTimeout(_ => {
|
||||
loadingEl.style.opacity = 0
|
||||
loadingEl.style.width = '0%'
|
||||
}, 200)
|
||||
}
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
import { isMobile } from './util'
|
||||
import { isMobile } from '../util/core'
|
||||
/**
|
||||
* Render github corner
|
||||
* @param {Object} data
|
||||
24
src/core/route/hash.js
Normal file
24
src/core/route/hash.js
Normal file
@ -0,0 +1,24 @@
|
||||
import { cleanPath, getLocation } from './util'
|
||||
|
||||
export function ensureSlash () {
|
||||
const path = getHash()
|
||||
if (path.charAt(0) === '/') return
|
||||
replaceHash('/' + path)
|
||||
}
|
||||
|
||||
export function getHash () {
|
||||
// We can't use window.location.hash here because it's not
|
||||
// consistent across browsers - Firefox will pre-decode it!
|
||||
const href = window.location.href
|
||||
const index = href.indexOf('#')
|
||||
return index === -1 ? '' : href.slice(index + 1)
|
||||
}
|
||||
|
||||
function replaceHash (path) {
|
||||
const i = window.location.href.indexOf('#')
|
||||
window.location.replace(
|
||||
window.location.href.slice(0, i >= 0 ? i : 0) + '#' + path
|
||||
)
|
||||
}
|
||||
|
||||
// TODO 把第二个 hash 转成 ?id=
|
||||
17
src/core/route/index.js
Normal file
17
src/core/route/index.js
Normal file
@ -0,0 +1,17 @@
|
||||
import { ensureSlash } from './hash'
|
||||
|
||||
export function routeMixin (Docsify) {
|
||||
Docsify.prototype.$route = {
|
||||
query: location.query || {},
|
||||
path: location.path || '/',
|
||||
base: ''
|
||||
}
|
||||
}
|
||||
|
||||
export function initRoute (vm) {
|
||||
ensureSlash()
|
||||
window.addEventListener('hashchange', () => {
|
||||
ensureSlash()
|
||||
vm.$fetch()
|
||||
})
|
||||
}
|
||||
11
src/core/route/util.js
Normal file
11
src/core/route/util.js
Normal file
@ -0,0 +1,11 @@
|
||||
export function cleanPath (path) {
|
||||
return path.replace(/\/+/g, '/')
|
||||
}
|
||||
|
||||
export function getLocation (base) {
|
||||
let path = window.location.pathname
|
||||
if (base && path.indexOf(base) === 0) {
|
||||
path = path.slice(base.length)
|
||||
}
|
||||
return (path || '/') + window.location.search + window.location.hash
|
||||
}
|
||||
56
src/core/util/core.js
Normal file
56
src/core/util/core.js
Normal file
@ -0,0 +1,56 @@
|
||||
/**
|
||||
* Create a cached version of a pure function.
|
||||
*/
|
||||
function cached (fn) {
|
||||
const cache = Object.create(null)
|
||||
return function cachedFn (str) {
|
||||
const hit = cache[str]
|
||||
return hit || (cache[str] = fn(str))
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Camelize a hyphen-delimited string.
|
||||
*/
|
||||
const camelizeRE = /-(\w)/g
|
||||
export const camelize = cached((str) => {
|
||||
return str.replace(camelizeRE, (_, c) => c ? c.toUpperCase() : '')
|
||||
})
|
||||
|
||||
/**
|
||||
* Simple Object.assign polyfill
|
||||
*/
|
||||
export const merge = Object.assign || function (to) {
|
||||
const hasOwn = Object.prototype.hasOwnProperty
|
||||
|
||||
for (let i = 1; i < arguments.length; i++) {
|
||||
const from = Object(arguments[i])
|
||||
|
||||
for (const key in from) {
|
||||
if (hasOwn.call(from, key)) {
|
||||
to[key] = from[key]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return to
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if value is primitive
|
||||
*/
|
||||
export function isPrimitive (value) {
|
||||
return typeof value === 'string' || typeof value === 'number'
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform no operation.
|
||||
*/
|
||||
export function noop () {}
|
||||
|
||||
/**
|
||||
* Check if value is function
|
||||
*/
|
||||
export function isFn (obj) {
|
||||
return typeof obj === 'function'
|
||||
}
|
||||
5
src/core/util/env.js
Normal file
5
src/core/util/env.js
Normal file
@ -0,0 +1,5 @@
|
||||
export const UA = window.navigator.userAgent.toLowerCase()
|
||||
|
||||
export const isIE = UA && /msie|trident/.test(UA)
|
||||
|
||||
export const isMobile = document.body.clientWidth <= 600
|
||||
2
src/core/util/index.js
Normal file
2
src/core/util/index.js
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './core'
|
||||
export * from './env'
|
||||
@ -1,4 +1,4 @@
|
||||
import { load } from './util'
|
||||
import { get } from '../fetch/ajax'
|
||||
|
||||
function replaceVar (block) {
|
||||
block.innerHTML = block.innerHTML.replace(/var\(\s*--theme-color.*?\)/g, $docsify.themeColor)
|
||||
@ -18,7 +18,7 @@ export function cssVars () {
|
||||
|
||||
if (!/\.css$/.test(href)) return
|
||||
|
||||
load(href).then(res => {
|
||||
get(href).then(res => {
|
||||
const style = document.createElement('style')
|
||||
|
||||
style.innerHTML = res
|
||||
57
src/hook.js
57
src/hook.js
@ -1,57 +0,0 @@
|
||||
export default class Hook {
|
||||
constructor () {
|
||||
this.beforeHooks = []
|
||||
this.afterHooks = []
|
||||
this.initHooks = []
|
||||
this.readyHooks = []
|
||||
this.doneEachHooks = []
|
||||
}
|
||||
|
||||
beforeEach (fn) {
|
||||
this.beforeHooks.push(fn)
|
||||
}
|
||||
|
||||
afterEach (fn) {
|
||||
this.afterHooks.push(fn)
|
||||
}
|
||||
|
||||
doneEach (fn) {
|
||||
this.doneEachHooks.push(fn)
|
||||
}
|
||||
|
||||
init (fn) {
|
||||
this.initHooks.push(fn)
|
||||
}
|
||||
|
||||
ready (fn) {
|
||||
this.readyHooks.push(fn)
|
||||
}
|
||||
|
||||
emit (name, data, next) {
|
||||
let newData = data
|
||||
const queue = this[name + 'Hooks']
|
||||
const step = function (index) {
|
||||
const hook = queue[index]
|
||||
if (index >= queue.length) {
|
||||
next && next(newData)
|
||||
} else {
|
||||
if (typeof hook === 'function') {
|
||||
if (hook.length === 2) {
|
||||
hook(data, result => {
|
||||
newData = result
|
||||
step(index + 1)
|
||||
})
|
||||
} else {
|
||||
const result = hook(data)
|
||||
newData = result !== undefined ? result : newData
|
||||
step(index + 1)
|
||||
}
|
||||
} else {
|
||||
step(index + 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
step(0)
|
||||
}
|
||||
}
|
||||
@ -235,36 +235,3 @@ export function renderCover (content) {
|
||||
|
||||
event.sticky()
|
||||
}
|
||||
|
||||
/**
|
||||
* render loading bar
|
||||
* @return {[type]} [description]
|
||||
*/
|
||||
export function renderLoading ({ loaded, total, step }) {
|
||||
let num
|
||||
|
||||
if (!CACHE.loading) {
|
||||
const div = document.createElement('div')
|
||||
|
||||
div.classList.add('progress')
|
||||
document.body.appendChild(div)
|
||||
CACHE.loading = div
|
||||
}
|
||||
if (step) {
|
||||
num = parseInt(CACHE.loading.style.width, 10) + step
|
||||
num = num > 80 ? 80 : num
|
||||
} else {
|
||||
num = Math.floor(loaded / total * 100)
|
||||
}
|
||||
|
||||
CACHE.loading.style.opacity = 1
|
||||
CACHE.loading.style.width = num >= 95 ? '100%' : num + '%'
|
||||
|
||||
if (num >= 95) {
|
||||
clearTimeout(renderLoading.cacheTimeout)
|
||||
renderLoading.cacheTimeout = setTimeout(_ => {
|
||||
CACHE.loading.style.opacity = 0
|
||||
CACHE.loading.style.width = '0%'
|
||||
}, 200)
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user