boxes/_includes/docs/index.md
2014-12-23 22:50:09 +01:00

1.9 KiB

Documentation

  1. General a. [Overview]({{ site.baseurl}}/about.html) & [Features]({{ site.baseurl}}/about.html#some-of-the-features) b. [News]({{ site.baseurl}}/) c. [FAQ](https://github.com/{{ site.github }}/wiki/FAQ) (Frequently Asked Questions)

  2. Legal Stuff

  3. [Examples]({{ site.baseurl}}/examples.html) a. [Default Action]({{ site.baseurl}}/examples.html) b. [Choosing a Different Design]({{ site.baseurl}}/examples.html#design) c. [The "-a" option - Alignment, Positioning & Line Justification]({{ site.baseurl}}/examples.html#position) d. [Size Specification]({{ site.baseurl}}/examples.html#size) e. [Padding]({{ site.baseurl}}/examples.html#padding) f. [Regional Comments]({{ site.baseurl}}/examples.html#comments) g. [Removal of Boxes]({{ site.baseurl}}/examples.html#removal) h. [Indentation Handling]({{ site.baseurl}}/examples.html#indent) i. [Use of Regular Expressions]({{ site.baseurl}}/examples.html#regexp)

  4. Creating Your Own Designs a. Introduction and General Concepts b. Configuration File Syntax c. Step-by-Step Guide to a New Design d. Complete examples of box designs e. [List of preconfigured designs]({{ site.baseurl}}/box-designs.txt)

  5. Text Editor Integration a. Integration with Vim b. Integration with Jed c. Integration with Emacs

  6. Development a. [Contributing]({{ site.baseurl}}/contributing.html) b. [List of Contributors]({{ site.baseurl}}/contributing.html#contributors) c. [Chronological Change Log](https://github.com/{{ site.github }}/commits/master)

  7. [Download]({{ site.baseurl}}/download.html)

  8. Boxes manual page (also in [troff format](https://github.com/{{ site.github }}/blob/master/doc/boxes.1.in))