<commit_before># Mapzen's documentation pipeline

We write our documentation in Markdown and store them iin GitHub, and use a [MkDocs](http://www.mkdocs.org/)-based automated workflow to convert them into friendlier static-site documentation pages hosted at https://mapzen.com/documentation/. You can read more about this on our [blog post](https://mapzen.com/blog/doc-site/
).

### Rapid bootstrapping

```shell
# Global dependencies that are needed (optional if you have them already)
# Installing python3 with Homebrew is the easiest way of getting what you need
brew install python3
pip3 install virtualenv

# Clone repository
git clone https://github.com/mapzen/mapzen-docs-generator.git<commit_msg>Added note about Heroku app to README file<commit_after># Mapzen's documentation pipeline

We write our documentation in Markdown and store them in GitHub, and use a [MkDocs](http://www.mkdocs.org/)-based automated workflow to convert them into friendlier static-site documentation pages hosted at https://mapzen.com/documentation/. You can read more about this on our [blog post](https://mapzen.com/blog/doc-site/).

## Status

Documentation is generated hourly from a scheduled task attached to the
[Heroku app `mapzen-docs-generator`](https://dashboard.heroku.com/apps/mapzen-docs-generator).

## Installation, Testing, And Use

### Rapid bootstrapping

```shell
# Global dependencies that are needed (optional if you have them already)
# Installing python3 with Homebrew is the easiest way of getting what you need
brew install python3
pip3 install virtualenv

# Clone repository
git clone https://github.com/mapzen/mapzen-docs-generator.git
{'fraction_non_alphanumeric': 0.08489993935718618, 'fraction_numerical': 0.0036385688295936932, 'mean_word_length': 4.978260869565218, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 7, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2383208', 'n_tokens_mistral': 450, 'n_tokens_neox': 432, 'n_words': 185}