标签 viewer 下的文章

MarkdocViewer

最近闲来无聊造了个文档阅读的东西,就一个单页,欢迎使用。

传送门:https://github.com/ycrao/markdoc-viewer

MarkdocViewer : reading markdown documentation from open git repository (just in one page) !

MarkdocViewer :从公开的 git 仓库阅读 markdown 文档 (就一个页面)!

参数配置

MarkdocViewer默认配置如下:

    this.defaults = {
            'base_url': 'https://raw.githubusercontent.com/',  //git 公共仓库 raw 基地址
            'base_dir': '',  //文档所在子目录,默认为空
            'repo_name': 'yascmf/docs',  //文档仓库名,默认为作者的 YASCMF 文档库
            'branch_name': 'master',  //文档所在分支,默认为master
            'index_file': 'index.md',  //目录索引文件,默认为index.md
            'home_file': 'readme.md',  //目录默认主页文件,默认为readme.md
            'sider_id': 'sider-menu',  //导航目录所在div的id名
            'content_id': 'content',  //markdown正文所在div的id名
        };

以上某些配置,可以通过传入查询串,予以重载新配置:

https://raoyc.com/markdoc-viewer?dir=&repo=yascmf/docs&branch=master&index=index.md&home=readme.md

其中,dir 查询串对应 base_dirrepo 对应 repo_name 配置,后面依次类推。请保证,查询串值与仓库文档实际结构目录一致。

- 阅读剩余部分 -