kylefang/docsify
1
0
Fork 0
mirror of https://github.com/zhigang1992/docsify.git synced 2026-04-23 21:00:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

customize sidebar and navbar via markdown file, #6 (#8)

Browse Source 
* Refactor: use iife

* Feat: customize sidebar and navbar via markdown file, #6

* Add changelog
This commit is contained in:
cinwell.li
2016-11-29 01:07:47 +08:00
committed by GitHub
parent e09b6f218f
commit 35d3bd1647
16 changed files with 625 additions and 333 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
src/render.js
View File

@@ -1,16 +1,15 @@
import marked from 'marked'
import Prism from 'prismjs'
import genToc from './gen-toc'
import * as tpl from './tpl'
import { activeLink, scrollActiveSidebar } from './event'
import { genTree } from './util'
const cornerTpl = `
<a href="{{repo}}" class="github-corner" aria-label="View source on Github">
<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="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>
</svg>
</a>
`
const renderTo = function (dom, content) {
dom = typeof dom === 'object' ? dom : document.querySelector(dom)
dom.innerHTML = content
return dom
}
const toc = []
const renderer = new marked.Renderer()
@@ -19,13 +18,12 @@ const renderer = new marked.Renderer()
* @link https://github.com/chjj/marked#overriding-renderer-methods
*/
renderer.heading = function (text, level) {
const slug = text.replace(/<(?:.|\n)*?>/gm, '').toLowerCase().replace(/[\s\n\t]+/g, '-')
const slug = text.toLowerCase().replace(/<(?:.|\n)*?>/gm, '').replace(/[\s\n\t]+/g, '-')
toc.push({ level, slug: '#' + slug, title: text })
return `<h${level} id="${slug}"><a href="#${slug}" class="anchor"></a>${text}</h${level}>`
}
// highlight code
renderer.code = function (code, lang = '') {
const hl = Prism.highlight(code, Prism.languages[lang] || Prism.languages.markup)
@@ -34,18 +32,52 @@ renderer.code = function (code, lang = '') {
}
marked.setOptions({ renderer })
export default function (content, opts = {}) {
let corner = ''
/**
* App
*/
export function renderApp (dom, replace, opts) {
const nav = document.querySelector('nav') || document.createElement('nav')
if (opts.repo) {
const repo = /\/\//.test(opts.repo) ? opts.repo : ('https://github.com/' + opts.repo)
corner = cornerTpl.replace(/{{repo}}/g, repo)
dom[replace ? 'outerHTML' : 'innerHTML'] = tpl.corner(opts.repo) + tpl.main()
document.body.insertBefore(nav, document.body.children[0])
}
/**
* article
*/
export function renderArticle (content = 'not found') {
renderTo('article', marked(content))
if (!renderSidebar.rendered) renderSidebar(null)
if (!renderNavbar.rendered) renderNavbar(null)
}
/**
* navbar
*/
export function renderNavbar (content, OPTIONS = {}) {
renderNavbar.rendered = true
if (content) renderTo('nav', marked(content))
activeLink('nav')
}
/**
* sidebar
*/
export function renderSidebar (content, OPTIONS = {}) {
renderSidebar.rendered = true
let isToc = false
if (content) {
content = marked(content)
} else if (OPTIONS.sidebar) {
content = tpl.tree(OPTIONS.sidebar, '<ul>')
} else {
content = tpl.tree(genTree(toc, OPTIONS.maxLevel), '<ul>')
isToc = true
}
const section = `<section class="content">
<article class="markdown-section">${marked(content)}</article>
</section>`
const sidebar = `<aside class="sidebar">${genToc(toc, opts)}</aside>`
return `${corner}<main>${sidebar}${section}</main>`
renderTo('aside.sidebar', content)
isToc ? scrollActiveSidebar() : activeLink('aside.sidebar', true)
}