payne8/docbox
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme to reflect real reality

Browse Source
This commit is contained in:
Tom MacWright
2017-09-27 11:18:01 -07:00
committed by GitHub
parent 45ac20aaa5
commit 22f01e6fd4
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -3,7 +3,7 @@
[![Circle CI](https://circleci.com/gh/tmcw/docbox.svg?style=shield)](https://circleci.com/gh/tmcw/docbox)
[![Greenkeeper badge](https://badges.greenkeeper.io/tmcw/docbox.svg)](https://greenkeeper.io/)
**Docbox is an open source version of [Mapbox](https://mapbox.com/)'s REST API documentation system.** It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown.
**Docbox is an open source REST API documentation system.** It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown.
[![](https://farm2.staticflickr.com/1534/24963539843_e26a00b3e1_b.jpg)](https://67-53007065-gh.circle-artifacts.com/0/tmp/circle-artifacts.NCC9T6a/index.html#our-api)
@ -15,8 +15,6 @@ _[Demo documentation](https://67-53007065-gh.circle-artifacts.com/0/tmp/circle-a
**When you're ready to ship**, Docbox's `build` task minifies JavaScript and uses React's server rendering code to make documentation indexable for search engines and viewable without JavaScript.
_Docbox is a [Mapbox](http://mapbox.com/) community open source project. We built an awesome system for our REST API documentation and wanted to share it with you. Not a Mapbox product, so there's no guaranteed support and may have some rough edges._
## Writing Documentation
Documentation is written as Markdown files in the `content` directory, and is organized by the `src/custom/content.js` file - that file requires each documentation page and puts them in order. This demo has a little bit of content - [content/example.md](content/example.md) and [content/introduction.md](content/introduction.md), so that there's an example to follow.
@ -42,7 +40,7 @@ We care about the ease of writing documentation. Docbox comes with batteries inc
To run the site locally:
1. Clone this repository
2. `git clone https://github.com/mapbox/docbox.git`
2. `git clone https://github.com/tmcw/docbox.git`
2. `npm install`
3. `npm start`
4. Open http://localhost:9966/
@ -54,7 +52,7 @@ Tests cover both the source code of Docbox as well as the content in the `conten
To run tests:
1. Clone this repository
2. `git clone https://github.com/mapbox/docbox.git`
2. `git clone https://github.com/tmcw/docbox.git`
2. `npm install`
3. `npm test`
@ -64,7 +62,7 @@ To run tests:
The `npm run build` command builds a `bundle.js` file that contains all the JavaScript code and content needed to show the site, and creates an `index.html` file that already contains the site content. Note that this _replaces_ the existing `index.html` file, so it's best to run this only when deploying the site and to undo changes to `index.html` if you want to keep working on content.
1. Clone this repository
2. `git clone https://github.com/mapbox/docbox.git`
2. `git clone https://github.com/tmcw/docbox.git`
2. `npm install`
3. `npm run build`
@ -79,4 +77,4 @@ The `npm run build` command builds a `bundle.js` file that contains all the Java
### [FAQ & See Also](https://github.com/mapbox/docbox/wiki)
Props to [Tripit's Slate project](https://github.com/tripit/slate), which served
as the inspiration for Docbox's layout. We also maintain a [list of similar projects](https://github.com/mapbox/docbox/wiki).
as the inspiration for Docbox's layout. We also maintain a [list of similar projects](https://github.com/tmcw/docbox/wiki).