diff --git a/README.md b/README.md index 9e03422..02437c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Docbox +[![Circle CI](https://circleci.com/gh/mapbox/docbox.svg?style=svg)](https://circleci.com/gh/mapbox/docbox) + **Docbox is an open source version of Mapbox'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 just Markdown. **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. diff --git a/circle.yml b/circle.yml new file mode 100644 index 0000000..1ec3d91 --- /dev/null +++ b/circle.yml @@ -0,0 +1,6 @@ +test: + post: + - npm run build + - mv index.html $CIRCLE_ARTIFACTS + - mv bundle.js $CIRCLE_ARTIFACTS + - mv css $CIRCLE_ARTIFACTS diff --git a/index.html b/index.html index 6cb9aad..8a998cd 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,6 @@ Mapbox -