GithubHelp home page GithubHelp logo

biggress / docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mindpin/docs

0.0 2.0 0.0 1.34 MB

团队帮助文档和技术参考

Ruby 1.31% HTML 2.91% CSS 40.12% JavaScript 50.24% CoffeeScript 5.43%

docs's Introduction

help

团队帮助文档和技术参考

使用 jekyll 构建

发布方法参考:
http://blog.nitrous.io/2013/08/30/using-jekyll-plugins-on-github-pages.html

编辑方法

签出 master 分支后,运行

bundle exec jekyll serve -H 0.0.0.0

增加项目就是在 _repos 目录下增加 md 文件
文件命名规则:

<账号名>-<工程名>.md

增加文件后需要填写文件头部,其中:

  • account: github 账号名
  • desc: 工程描述(如果原来的描述不详细,这里写详细一点)
  • created: 工程创建时间
  • updated: 工程最后提交时间
  • last-commit: 最后一次 commit 的 id
  • type: 工程类型 (项目 project , 库 lib , 演示 demo , 文档汇总 doc)
  • alternative: 是否有替代方案
  • skills: 开发此工程需要的技能
  • threads: 隶属于哪条主线,例如:属于 img4ye 就写 [img4ye]
  • design-usage: 最初的设计用途

其他参考资料

http://stackoverflow.com/questions/28100220/jekyll-display-collection-by-category

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.