MarkdocViewer
最近闲来无聊造了个文档阅读的东西,就一个单页,欢迎使用。
传送门:https://github.com/ycrao/markdoc-viewer
MarkdocViewer : reading markdown documentation from open git repository (just in one page) !
MarkdocViewer :从公开的
git仓库阅读markdown文档 (就一个页面)!
参数配置
MarkdocViewer默认配置如下:
// default options
{
// git repo raw file base_url, default to github
'base_url': 'https://raw.githubusercontent.com/',
// document directory, default empty
'base_dir': '',
// git repo name, default 'yascmf/docs'
'repo_name': 'ycrao/mynotes',
// git branch name, default 'master'
'branch_name': 'master',
// index file name, using it to generate sider -nav menu
'index_file': 'index.md',
// home file name, default 'README.md'
'home_file': 'intro.md',
// element id for left-sider or right-sider menu in HTML
'sider_id': 'sider-menu',
// element id for main content in HTML
'content_id': 'content',
}以上某些配置,可以通过传入查询串,予以重载新配置:
https://raoyc.com/markdoc-viewer?doc=intro.md&dir=&index=index.md&repo=ycrao/mynotes&home=intro.md&branch=master
其中,dir 查询串对应 base_dir 、repo 对应 repo_name 配置,后面依次类推。请保证,查询串值与仓库文档实际结构目录一致。
豆芽丝