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

Update example

Browse Source
This commit is contained in:
Tom MacWright
2016-05-20 14:10:38 -04:00
parent ffdf4a6123
commit 873392eb51
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -4,9 +4,9 @@
**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.
[![](https://farm2.staticflickr.com/1534/24963539843_e26a00b3e1_b.jpg)](https://circle-artifacts.com/gh/mapbox/docbox/38/artifacts/0/tmp/circle-artifacts.jMIoUkM/index.html#update-a-wobble)
[![](https://farm2.staticflickr.com/1534/24963539843_e26a00b3e1_b.jpg)](https://circle-artifacts.com/gh/mapbox/docbox/50/artifacts/0/tmp/circle-artifacts.8SMOD8H/index.html#our-api)
_[Demo documentation](https://circle-artifacts.com/gh/mapbox/docbox/38/artifacts/0/tmp/circle-artifacts.jMIoUkM/index.html#update-a-wobble)_
_[Demo documentation](https://circle-artifacts.com/gh/mapbox/docbox/50/artifacts/0/tmp/circle-artifacts.8SMOD8H/index.html#our-api)_
**Docbox is a JavaScript application written with React.** The core magic is thanks to the [remark](http://remark.js.org/) Markdown parser, which enables the layout: after parsing a file into an [Abstract Syntax Tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree), we can move examples to the right, prose to the left, and build the navigation system.