Files
boxes/docs/index.html

49 lines
2.2 KiB
HTML

---
layout: markdown
---
# Documentation
1. General\\
a. [Overview]({{ site.baseurl}}/about.html) & [Features]({{ site.baseurl}}/about.html#some-of-the-features)\\
b. [News]({{ site.baseurl}}/)\\
c. [FAQ]({{ site.baseurl}}/docs/faq.html) (Frequently Asked Questions)
1. [Legal Stuff](legal.html)
1. [Examples]({{ site.baseurl}}/examples.html)\\
a. [Default Action]({{ site.baseurl}}/examples.html)\\
b. [Choosing a Different Design]({{ site.baseurl}}/examples.html#design)\\
c. [The &quot;<TT>-a</TT>&quot; option - Alignment, Positioning &amp; 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)
1. Creating Your Own Designs\\
a. [Introduction and General Concepts](config-general.html)\\
b. [Configuration File Syntax](config-syntax.html)\\
c. [Step-by-Step Guide to a New Design](config-step.html)\\
d. [Complete examples of box designs](config-complete_exp.html)\\
e. [List of preconfigured designs]({{ site.baseurl}}/box-designs.txt)
1. [Text Editor Integration](install.html)\\
a. [Integration with Vim](install.html)\\
b. [Integration with Jed](install.html#jed)\\
c. [Integration with Emacs](install.html#emacs)\\
d. [Integration with Sublime Text](install.html#sublime)\\
e. [Integration with Notepad++](install.html#notepadplusplus)
1. Development\\
a. [Contributing]({{ site.baseurl}}/contributing.html)\\
b. [List of Contributors]({{ site.baseurl}}/contributing.html#contributors)\\
c. [Building from Source]({{ site.baseurl}}/build.html)\\
d. [Testing]({{ site.baseurl}}/testing.html)\\
e. [Chronological Change Log](https://github.com/{{ site.github }}/commits/master)
1. [Download]({{ site.baseurl}}/download.html)
1. [*Boxes* manual page](boxes-man-1.html) (also in [troff format](https://github.com/{{ site.github }}/blob/master/doc/boxes.1.in))