<commit_before>= AsciiBinder for Authors
{product-author}
{product-version}
:data-uri:
:icons:

If you want to contribute documentation to a project that manages its docs with AsciiBinder, you've come to the right place.

== Installing AsciiBinder
AsciiBinder is distributed as a Ruby gem, so use the `gem` command to install it:

----
$ gem install ascii_binder
----

But be aware of a few prerequisites:

1. **Pandoc**: AsciiBinder uses the awesome http://asciidoctor.org/[AsciiDoctor] processor to generate pages, and AsciiDoctor depends upon http://pandoc.org/[Pandoc]. So, make sure `pandoc` is installed on your system.
2. **Java**: AsciiBinder bundles http://ditaa.sourceforge.net/[ditaa] for ASCII-based diagramming support. However, ditaa depends upon a Java runtime to transform ASCII diagrams into image files. So, make sure you have a JVM installed (http://openjdk.java.net/[OpenJDK] works fine) and set the `$JAVA_HOME` environment variable so that ditaa can find the JVM.

== Making a Copy of an Existing Docs Repo
If you already know how to use https://git-scm.com/[git], then this is going to sound very familiar. If not, here's the full walk-through:

1. Install git.
2. If the docs source is hosted on GitHub, you will probably next need to https://help.github.com/articles/fork-a-repo/[fork] the docs repo.
3. Using git, clone the repo (either the original or your fork, as appropriate) to your local system: `git clone <repo URL>`

If the project that you are working in already has version branches, then you will want to set up local copies of those as well. After you have cloned the repo to your local system, you can track those branches with the command:

----
$ git checkout -b <local_branch_name> <remote_repo>/<remote_branch_name>
----

== Building the Docs
Transforming an AsciiBinder repo into a bunch of documentation is pretty easy:

----
$ asciibinder build <repo_dir>
----

If you run this from the root directory of your repo, you can simply run:

----
$ asciibinder
----

...because it will assume the current repo if none is specified, and it will assume `build` if no operation is specified.<commit_msg>Remove erroneous pandoc requirement<commit_after>= AsciiBinder for Authors
{product-author}
{product-version}
:data-uri:
:icons:

If you want to contribute documentation to a project that manages its docs with AsciiBinder, you've come to the right place.

== Installing AsciiBinder
AsciiBinder is distributed as a Ruby gem, so use the `gem` command to install it:

----
$ gem install ascii_binder
----

But be aware of one additional prerequisite:

**Java**: AsciiBinder bundles http://ditaa.sourceforge.net/[ditaa] for ASCII-based diagramming support. However, ditaa depends upon a Java runtime to transform ASCII diagrams into image files. So, make sure you have a JVM installed (http://openjdk.java.net/[OpenJDK] works fine) and set the `$JAVA_HOME` environment variable so that ditaa can find the JVM.

== Making a Copy of an Existing Docs Repo
If you already know how to use https://git-scm.com/[git], then this is going to sound very familiar. If not, here's the full walk-through:

1. Install git.
2. If the docs source is hosted on GitHub, you will probably next need to https://help.github.com/articles/fork-a-repo/[fork] the docs repo.
3. Using git, clone the repo (either the original or your fork, as appropriate) to your local system: `git clone <repo URL>`

If the project that you are working in already has version branches, then you will want to set up local copies of those as well. After you have cloned the repo to your local system, you can track those branches with the command:

----
$ git checkout -b <local_branch_name> <remote_repo>/<remote_branch_name>
----

== Building the Docs
Transforming an AsciiBinder repo into a bunch of documentation is pretty easy:

----
$ asciibinder build <repo_dir>
----

If you run this from the root directory of your repo, you can simply run:

----
$ asciibinder
----

...because it will assume the current repo if none is specified, and it will assume `build` if no operation is specified.
{'fraction_non_alphanumeric': 0.08577712609970674, 'fraction_numerical': 0.0019550342130987292, 'mean_word_length': 4.04064039408867, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 4, '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': '4786071', 'n_tokens_mistral': 1210, 'n_tokens_neox': 1140, 'n_words': 586}