1 Star 2 Fork 0

git-books / git-books

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

markdown documents site reader

一个非常简单的markdown文档站点阅读器小工具,自动拉取目录数据并生成目录侧边栏,自动根据文档生成TOC

  • 纯静态渲染,只要有一个可以放静态文件的服务器, 配置好相关信息。访问 index.html 即可
  • 原生支持渲染 gitbook 导出的 markdown 站点
  • 可直接渲染github上的任意一个 markdown 文档仓库,无需拉取仓库代码
  • 简单的目录搜索功能支持(会将目录的 链接文字和链接href 作为匹配目标)
  • 样式使用基于bootstrap 3 的 bootswatch(可以直接在页面底部切换各种主题)
  • 自动缓存内容到本地(localSorage),加快二次打开速度
  • 使用highlight添加代码高亮支持

访问站点: https://git-books.github.io

仓库地址: https://github.com/git-books/git-books.github.io

基于项目:inhere/md-site-reader

已有书籍

使用以及配置

你可以通过 config.js 来覆盖默认配置, 然后访问 index.html 即可

全部配置项

// file: assets/js/config.defalut.js
{
  // use for cache prefix
  siteKey: 'swoft',
  siteName: 'Swoft',
  siteDes: 'the description text',
  // page title = baseTile + content title
  baseTitle: 'Swoft Doc',
  // basePath: ,
  logoUrl: '/',

  docProject: 'swoft-cloud/swoft-doc',
  // e.g https://raw.githubusercontent.com/{swoft-cloud/swoft-doc}/master/{beanfactory.md}
  dataUrl: 'https://raw.githubusercontent.com/swoft-cloud/swoft-doc/master/',
  docUrl: 'https://github.com/swoft-cloud/swoft-doc',
  // e.g https://github.com/swoft-cloud/swoft-doc/blob/master/http.md
  editUrl: 'https://github.com/swoft-cloud/swoft-doc/blob/master',

  project: 'swoft-cloud/swoft',
  projectUrl: 'https://github.com/swoft-cloud/swoft',
  issueUrl: 'https://github.com/swoft-cloud/swoft/issues',

  authorPage: 'https://github.com/stelin',
  authorName: 'stelin',

  emptyData: 'No content to display!',
  catelogPage: 'SUMMARY.md',
  defaultPage: 'README.md',

  // assets/lib/bootswatch/{theme:paper}/bootstrap.min.css
  theme: 'paper',
  // assets/lib/highlight/styles/{codeTheme:github}.css
  codeTheme: 'github',
  makeTOC: true,
  /* £ $ & β ξ ψ ℘ § */
  anchorIcon: '',
  tableClass: 'table table-bordered table-striped'
}

License

MIT

MIT License Copyright (c) 2017 Inhere Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

暂无描述 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/git-books/git-books.git
git@gitee.com:git-books/git-books.git
git-books
git-books
git-books
master

搜索帮助