<commit_before>JDoc
====
Pretty documentation generator for large projects

Description
-----------

JDoc is a Jekyll plugin that lets you organize your documentation into a hierarchical file structure.  It was created primarily to generate [Project Pages](http://pages.github.com/) for large projects where the documentation needs to be organized hierarchically across multiple files.

For example, [this code](https://github.com/tombenner/wp-mvc-doc/tree/master/documentation) produces [this result](http://wpmvc.org/).

Getting Started
---------------

1. Install [jekyll](https://github.com/mojombo/jekyll)
1. Clone [jdoc-example](https://github.com/tombenner/jdoc-example) recursively to include its submodule:  
`git clone --recursive git://github.com/tombenner/jdoc-example.git`
1. Start jekyll using `jekyll --server` ([read more](https://github.com/mojombo/jekyll/wiki/usage)) and see the site [here](http://localhost:4000/jdoc-example/)
1. Edit the files in `documentation/` to start documenting!

Tips:

* You might want to use `jekyll --server --auto` to automatically regenerate the site when you modify files.
* You can change the root URL of the site with the `baseurl` value in _config.yml.
* A larger example can be found [here](https://github.com/tombenner/wp-mvc-doc).

File Structure
--------------

Documentation is organized in the `documentation` directory in root Jekyll directory.  The file structure looks like this:

    documentation/
        first_topic/
            _sort.yml
            first_subtopic.md
            second_subtopic.md
            index.md
        second_topic.md

This structure will be rendered into a hierarchical menu.  `index.md` is the content that's shown for `first_topic`.

`_sort.yml` is optional.  If it's included in a directory, it specifies the order in which that directory's topics are rendered in the menu.  In the example above, it might look like this:

    first_subtopic
    second_subtopic

Documentation Syntax
--------------------

Each file behaves just like a Jekyll file does, except that the YAML header isn't required. An initial `---` is required, though:
<commit_msg>Removing redundant link to wp-mvc-doc as an example<commit_after>JDoc
====
Pretty documentation generator for large projects

Description
-----------

JDoc is a Jekyll plugin that lets you organize your documentation into a hierarchical file structure.  It was created primarily to generate [Project Pages](http://pages.github.com/) for large projects where the documentation needs to be organized hierarchically across multiple files.

For example, [this code](https://github.com/tombenner/wp-mvc-doc/tree/master/documentation) produces [this result](http://wpmvc.org/).

Getting Started
---------------

1. Install [jekyll](https://github.com/mojombo/jekyll)
1. Clone [jdoc-example](https://github.com/tombenner/jdoc-example) recursively to include its submodule:  
`git clone --recursive git://github.com/tombenner/jdoc-example.git`
1. Start jekyll using `jekyll --server` ([read more](https://github.com/mojombo/jekyll/wiki/usage)) and see the site [here](http://localhost:4000/jdoc-example/)
1. Edit the files in `documentation/` to start documenting!

Tips:

* You might want to use `jekyll --server --auto` to automatically regenerate the site when you modify files.
* You can change the root URL of the site with the `baseurl` value in _config.yml.

File Structure
--------------

Documentation is organized in the `documentation` directory in root Jekyll directory.  The file structure looks like this:

    documentation/
        first_topic/
            _sort.yml
            first_subtopic.md
            second_subtopic.md
            index.md
        second_topic.md

This structure will be rendered into a hierarchical menu.  `index.md` is the content that's shown for `first_topic`.

`_sort.yml` is optional.  If it's included in a directory, it specifies the order in which that directory's topics are rendered in the menu.  In the example above, it might look like this:

    first_subtopic
    second_subtopic

Documentation Syntax
--------------------

Each file behaves just like a Jekyll file does, except that the YAML header isn't required. An initial `---` is required, though:

{'fraction_non_alphanumeric': 0.11202635914332784, 'fraction_numerical': 0.0037655919039774064, 'mean_word_length': 3.327902240325866, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, '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': '6731477', 'n_tokens_mistral': 1206, 'n_tokens_neox': 1150, 'n_words': 464}