0x00_读论文 8
0x11_算法平台 15
0x21_有监督学习 21
0x24_NLP 13
0x25_CV 11
0x26_torch 11
0x31_降维 10
0x33_图模型 9
0x43_时间序列 10
0x51_代数与分析 15
0x56_最优化 11
0x58_密码学 12
0x70_可视化 13
0x80_数据结构与算法 17
配置项
你可以配置在 window.$docsify 里。
<script>
window.$docsify = {
repo: 'docsifyjs/docsify',
maxLevel: 3,
coverpage: true
}
</script>
repo
- 类型：
String - 默认值:
null
配置仓库地址或者 username/repo 的字符串，会在页面右上角渲染一个 GitHub Corner 挂件。
window.$docsify = {
repo: 'docsifyjs/docsify',
// or
repo: 'https://github.com/docsifyjs/docsify/'
};
maxLevel
- 类型：
Number - 默认值:
6
默认情况下会抓取文档中所有标题渲染成目录，可配置最大支持渲染的标题层级。
window.$docsify = {
maxLevel: 4
};
subMaxLevel
- 类型：
Number - 默认值:
0
自定义侧边栏后默认不会再生成目录，你也可以通过设置生成目录的最大层级开启这个功能。
window.$docsify = {
subMaxLevel: 2
};
homepage
- 类型：
String - 默认值:
README.md
设置首页文件加载路径。适合不想将 README.md 作为入口文件渲染，或者是文档存放在其他位置的情况使用。
window.$docsify = {
// 入口文件改为 /home.md
homepage: 'home.md',
// 文档和仓库根目录下的 README.md 内容一致
homepage:
'https://raw.githubusercontent.com/docsifyjs/docsify/master/README.md'
};
logo
- Type:
String
Website logo as it appears in the sidebar, you can resize by CSS.
window.$docsify = {
logo: '/_media/icon.svg'
};
name
- 类型：
String
文档标题，会显示在侧边栏顶部。
window.$docsify = {
name: 'docsify'
};
nameLink
- 类型：
String - 默认值：
window.location.pathname
点击文档标题后跳转的链接地址。
window.$docsify = {
nameLink: '/',
// 按照路由切换
nameLink: {
'/zh-cn/': '/zh-cn/',
'/': '/'
}
};
markdown
- 类型:
Object|Function
参考 Markdown 配置。
window.$docsify = {
// object
markdown: {
smartypants: true,
renderer: {
link: function() {
// ...
}
}
},
// function
markdown: function(marked, renderer) {
// ...
return marked;
}
};
themeColor
- 类型：
String
替换主题色。利用 CSS3 支持变量的特性，对于老的浏览器有 polyfill 处理。
window.$docsify = {
themeColor: '#3F51B5'
};
alias
- 类型：
Object
定义路由别名，可以更自由的定义路由规则。 支持正则。
window.$docsify = {
alias: {
'/foo/(+*)': '/bar/$1', // supports regexp
'/zh-cn/changelog': '/changelog',
'/changelog':
'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG',
'/.*/_sidebar.md': '/_sidebar.md' // See #301
}
};
autoHeader
- 类型：
Boolean
同时设置 loadSidebar 和 autoHeader 后，可以根据 _sidebar.md 的内容自动为每个页面增加标题。#78
window.$docsify = {
loadSidebar: true,
autoHeader: true
};
executeScript
- 类型：
Boolean
执行文档里的 script 标签里的脚本，只执行第一个 script (demo)。 如果 Vue 存在，则自动开启。
window.$docsify = {
executeScript: true
};
## This is test
<script>
console.log(2333)
</script>
注意如果执行的是一个外链脚本，比如 jsfiddle 的内嵌 demo，请确保引入 external-script 插件。
noEmoji
- type:
Boolean
禁用 emoji 解析。
window.$docsify = {
noEmoji: true
};
mergeNavbar
- type:
Boolean
小屏设备下合并导航栏到侧边栏。
window.$docsify = {
mergeNavbar: true
};
formatUpdated
- type:
String|Function
我们可以显示文档更新日期通过 {docsify-updated} 变量. 并且格式化日期通过 formatUpdated。参考 https://github.com/lukeed/tinydate#patterns
window.$docsify = {
formatUpdated: '{MM}/{DD} {HH}:{mm}',
formatUpdated: function(time) {
// ...
return time;
}
};
externalLinkTarget
- type:
String - default:
_blank
当前默认为 _blank, 配置一下就可以：
window.$docsify = {
externalLinkTarget: '_self' // default: '_blank'
};
routerMode
- type:
String - default:
hash
window.$docsify = {
routerMode: 'history' // default: 'hash'
};
noCompileLinks
- 类型:
Array
有时我们不希望 docsify 处理我们的链接。 参考 #203
window.$docsify = {
noCompileLinks: ['/foo', '/bar/.*']
};
requestHeaders
- type:
Object
设置请求资源的请求头。
window.$docsify = {
requestHeaders: {
'x-token': 'xxx'
}
};
ext
- type:
String
资源的文件扩展名。
window.$docsify = {
ext: '.md'
};
fallbackLanguages
- type:
Array<string>
List of languages that will fallback to the default language when a page is request and didn’t exists for the given local.
Example:
- try to fetch the page of
/de/overview. If this page exists, it’ll be displayed - then try to fetch the default page
/overview(depending on the default language). If this page exists, it’ll be displayed - then display 404 page.
window.$docsify = {
fallbackLanguages: ['fr', 'de']
};
notFoundPage
-
type: BooleanStringObject
Load the _404.md file:
window.$docsify = {
notFoundPage: true
};
Load the customised path of the 404 page:
window.$docsify = {
notFoundPage: 'my404.md'
};
Load the right 404 page according to the localisation:
window.$docsify = {
notFoundPage: {
'/': '_404.md',
'/de': 'de/_404.md'
}
};
Note: The options with fallbackLanguages didn’t work with the
notFoundPageoptions.