What is it?


Using Bootstrap document Template to write document for your project.

  • Based on Jekyll
  • Bootstrap document style
  • Very easy to use
  • Write in markdown
  • Bootstrap
  • Multiple languages

Examples


http://cube-sdk.liaohuqiu.net/

http://jekyll-langs.liaohuqiu.net/

Jekyll

First we need use Jekyll to build the content.

A post about: Install jekyll on CentOS


How to use


You can fork the github repository, or download zip package.

Github

Fork it in Github, use the souce code in your project.

git checkout -b docs
git merge https://github.com/liaohuqiu/bt-docs
git submodule upate
git commit
git push origin docs
View on Github

Copy file

If you dont use git, you can download the zip package.

The copy the files into your document directory.

Download zip

Directory structure

bt-docs/
 ├── assets         # js / css / image
 ├── _config.yml    # configure for jekyll
 ├── dist           # js / css of bootstrap
 ├── _includes      # templete parts
 ├── _layouts
 ├── _plugins
 ├── README.md
 └── _site          # the site content will be build to 

Configure

  • _config.yml
# site information
info:
  site_name:        Bt-docs

meta:
  description:      "The default description for this site"
  keywords:         "Default keywords for this site"
  author:           "Author information"

# multiple language
language_default:   'en'

languages:          ["en", "cn"]

# left navigation
left_nav:
  en:
    title:          The title
    path:           /
    items:
      - path:       /page1
        title:      "Another page"
      - path:       /page2
        title:      "Yet another page"
  cn:
    title:          "网站标题"
    path:           /cn
    items:
      - path:       /cn/page1
        title:      "页面1"
      - path:       /cn/page2
        title:      "页面2"

# right navigation
right_nav:
  - title:          English Version
    url:            /
  - title:          中文版文档
    url:            /cn
  - title:          Fork on Github
    url:            https://github.com/liaohuqiu/bt-docs

# analytics account information, remember to change this.
analytics:
  google:
    account:         UA-43024238-5

Build & Deploy

If you are using git, please remember git submodule update before build.

If not specified in _config.yml, The site content will be generated into the destination directory, for example: _site.

You can debug the site locally: jekyll server -w.

Github Pages Issue

Multiple Languages is sported by Jekyll Multiple Languages Plugin, and Github page runs in a safe mode in which most of the plugins can not run.

If your website is hosted in Github, here is a solution: How to use Jekyll plugins on Github Pages