params.json

{
  "name": "Progit",
  "tagline": "Pro Git （第一版） 中文版",
  "body": "# About\r\nThis project aims to generate html pages for *Pro Git* book from [*Book Source*](https://github.com/progit/progit) using node.js.\r\n\r\nThe generated HTML pages can be hosted on the [GitHub](http://github.com) via [Github Pages](https://pages.github.com). \r\n\r\n## Demo\r\n - [demo](http://iissnan.com/progit).\r\n\r\n## Screenshots\r\n\r\n - [Desktop](assets/img/preview-desktop.png?raw=true)\r\n - [Tablet](assets/img/preview-tablet.png?raw=true)\r\n - [Mobile](assets/img/preview-mobile.png?raw=true)\r\n\r\n\r\n ![Mobile](assets/img/preview-mobile.png?raw=true)\r\n\r\n\r\n\r\n\r\n## How to build\r\n\r\n1. Download and install [Node.js](http://nodejs.org).\r\n2. Get a copy of this project:\r\n\r\n    ```\r\n    git clone https://github.com/iissnan/progit.git progit\r\n    ```\r\n\r\n    If you want to host this pages yourself, you need to fork this project to your account first.\r\n\r\n\r\n3. Install dependencies:\r\n    \r\n    ```\r\n    npm install\r\n    ```\r\n\r\n4. Get book source:\r\n\r\n    Book source is involved as a git submodule.\r\n    Run the following command to init the submodule.\r\n\r\n    ```\r\n    git submodule init\r\n    git submodule update\r\n    ````\r\n\r\n5. Generate HTML pages:\r\n    \r\n    ```\r\n    node lib/build\r\n    ```\r\n   \r\n6. Push to your repository's gh-pages branch.\r\n\r\n    ```\r\n    git push origin gh-pages\r\n    ```\r\n\r\n\r\n\r\n\r\n\r\n",
  "note": "Don't delete this file! It's used internally to help with page regeneration."
}