<commit_before>## About

Backdoc is a tool for backbone-like documentation generation.
Backdoc main goal is to help to generate one page documentation from one markdown source file.  

Resulting html is a solid markup with inline styles.  

After generation you can save result to github-pages or even send html file by email.

* [Demo source](https://raw.github.com/chibisov/backdoc/blob/master/demo/demo.md)
* [Demo result](http://chibisov.github.io/backdoc/demo/demo.html)

## Usage

    $ wget https://github.com/chibisov/backdoc/master/backdoc.py
    $ python backdoc.py doc.md > doc.html
    $ # or
    $ echo "# Hello" | python backdoc.py > doc.html

## Usage without installation

    $ curl https://raw.github.com/chibisov/backdoc/master/backdoc.py | python doc.md > doc.html
    $ # or
    $ echo "# Hello " curl https://raw.github.com/chibisov/backdoc/master/backdoc.py | python > doc.html

## Development process

For simplicity sake `backdoc.py` script should be solid python script, without any requirements to install.  
If you add any third-party libraries you should download theme to `src` folder.  

There is a folder, where all source files keeped. After dowload you should add compilation logic to `compile.py`.

Development algorithm:

    1 Write code to src/backdoc.py<commit_msg>right demo link<commit_after>## About

Backdoc is a tool for backbone-like documentation generation.
Backdoc main goal is to help to generate one page documentation from one markdown source file.  

Resulting html is a solid markup with inline styles.  

After generation you can save result to github-pages or even send html file by email.

* [Demo source](https://raw.github.com/chibisov/backdoc/master/demo/demo.md)
* [Demo result](http://chibisov.github.io/backdoc/demo/demo.html)

## Usage

    $ wget https://github.com/chibisov/backdoc/master/backdoc.py
    $ python backdoc.py doc.md > doc.html
    $ # or
    $ echo "# Hello" | python backdoc.py > doc.html

## Usage without installation

    $ curl https://raw.github.com/chibisov/backdoc/master/backdoc.py | python doc.md > doc.html
    $ # or
    $ echo "# Hello " curl https://raw.github.com/chibisov/backdoc/master/backdoc.py | python > doc.html

## Development process

For simplicity sake `backdoc.py` script should be solid python script, without any requirements to install.  
If you add any third-party libraries you should download theme to `src` folder.  

There is a folder, where all source files keeped. After dowload you should add compilation logic to `compile.py`.

Development algorithm:

    1 Write code to src/backdoc.py
{'fraction_non_alphanumeric': 0.09558541266794626, 'fraction_numerical': 0.0007677543186180423, 'mean_word_length': 3.620567375886525, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 11, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2690320', 'n_tokens_mistral': 789, 'n_tokens_neox': 762, 'n_words': 275}