DOCter, 项目文档的osm模板

分享于 

4分钟阅读

GitHub

  繁體 雙語
A Jekyll template for project documentation
  • 源代码名称:DOCter
  • 源代码网址:http://www.github.com/cfpb/DOCter
  • DOCter源代码文档
  • DOCter源代码下载
  • Git URL:
    git://www.github.com/cfpb/DOCter.git
    Git Clone代码到本地:
    git clone http://www.github.com/cfpb/DOCter
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/cfpb/DOCter
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    DOCter

    DOCter是一个用于快速构建项目页面和文档的 Jekyll模板。

    DOCter Screenshot

    请参见演示文稿

    在本地运行 DOCter

    DOCter需要使用osm和其他依赖来在本地运行。 这些命令可以通过运行以下命令与Bundler一起安装。

    
    gem install bundler
    
    
    bundle install
    
    
    
    

    fork 并克隆 repo:

    
    git clone git@github.com:cfpb/DOCter.git
    
    
    cd DOCter
    
    
    
    

    运行 Jekyll

    
    bundle exec jekyll serve --watch --baseurl ''
    
    
    
    

    在浏览器中打开它: http://localhost:4000/

    _config.yml

    _config.yml 文件中的选项允许你控制站点标题。副标题。logo。作者信息和左栏导航。

    项目页面URL结构

    这是一个从文档的摘录,关于为项目页面配置你的网址。

    有时候,在将 gh-pages 分支推送到GitHub之前预览你的Jekyll站点是不错的。 但是,如URL结构GitHub用于项目页面的子目录复杂地解决了网址的正确分辨率。 下面是使用GitHub项目页面URL结构( username.github.io/project-name/ )的方法,同时保持在本地预览你的osm站点的能力。

    • baseurl 选项设置为 /project-name --,注意前导斜杠的前导斜杠和的
    • 在引用JS或者CSS文件时,请按如下方式操作: {{ site.baseurl }}/path/to/css.css --注意紧跟在变量( 在这之前"路径") 后面的斜杠。
    • 执行永久链接或者内部链接时,请执行如下操作: {{ site.baseurl }}{{ post.url }} --注意到在两个变量之间没有 slash。
    • 如果使用 jekyll serve 在提交/部署之前预览站点,请确保将空字符串传递给 --baseurl 选项,以便你可以在正常情况下查看所有的localhost:4000: jekyll serve --baseurl ''

    这样,可以从本地站点上的站点 root 预览站点,但当GitHub从,页生成页面时,所有的url都将从 /project-name 开始。

    脱机支持

    DOCter通过服务工作人员提供可选的脱机支持。 这意味着,当启用了DOCter站点初始负载后,缓存版本将在某些现代浏览器中脱机使用。

    启用脱机缓存的:

    _config.yml: 将 offline_cache 设置为 true ( 默认为 false )

    更新你站点的高速缓存版本的:

    _config.yml: 更改 cache_name 值( 这应该通过对站点的每一次重大更新来完成)

    向高速缓存添加额外文件的费用为:

    sw.js 中:更新 filesToCache array

    许可证

    项目在 public 域中,所有对它的贡献都将以这样的方式发布。 通过提交请求请求,你同意放弃所有权利,以在 CC0 public 域奉献模式下的你的贡献。

    如果你贡献别人的开放源码工作,请在你的请求请求中明确地。


    相关文章