create an mdbook for documentation

.gitignore

@@ -2,3 +2,6 @@
 /tests/plain.fmt
 /tests/00*00-latex-*.fmt
 /tests/00*00-plain-*.fmt
+
+# ignore mdbook compiled output (HTML)
+docs/book/*

docs/book.toml

@@ -0,0 +1,13 @@
+[book]
+title = "The Tectonic Typesetting System"
+authors = ["Tectonic Contributers"]
+description = "a book documenting the tectonic project for developers"
+language = "en"
+multilingual = false
+src = "src"
+[output.html]
+# see lively issue: https://github.com/rust-lang-nursery/mdBook/issues/847
+google-analytics = false
+# FIXME these do not seem to appear anywhere?
+git-repository-url = "https://github.com/tectonic-typesetting/tectonic"
+git-repository-icon = "fa-github"

docs/src/README.md

@@ -0,0 +1,13 @@
+# Tectonic Overview
+
+Tectonic is a modernized, complete, self-contained
+[TeX](https://en.wikipedia.org/wiki/TeX)/[LaTeX](https://www.latex-project.org/)
+engine, powered by [XeTeX](http://xetex.sourceforge.net/) and
+[TeXLive](https://www.tug.org/texlive/).
+
+## documentation
+
+We are writing developer facing documentation using [mdbook](https://rust-lang-nursery.github.io/mdBook/index.html).
+This lives in the `docs` sub directory of the main [tectonic repository](https://github.com/tectonic-typesetting/tectonic).
+
+See discussion in [#62](https://github.com/tectonic-typesetting/tectonic/issues/62) for ideas.

docs/src/SUMMARY.md

@@ -0,0 +1,9 @@
+# Tectonic Documentation
+
+- [Overview](README.md)
+- [Project Structure](project/README.md)
+    - [tectonic](project/tectonic.md)
+    - [tectonic-fuzz](project/fuzz.md)
+- [Resources](resources/README.md)
+
+-----------

docs/src/project/README.md

@@ -0,0 +1,5 @@
+# overview of tectonic project structure
+
+## Goals of the Project
+## How the Code is Structured
+## How to Contribute

docs/src/project/fuzz.md

@@ -0,0 +1,4 @@
+# tectonic-fuzz
+
+A fuzzing tool to test tectonic.
+See the directory's [README.md](https://github.com/tectonic-typesetting/tectonic/tree/master/fuzz) for more.

docs/src/project/tectonic.md

@@ -0,0 +1,11 @@
+# tectonic
+
+To see available options, run `tectonic --help`.
+This page documents usage details not appropriate to the CLI.
+
+
+## the configuration file
+
+You can configure common options by using a configuration file.
+
+See [issue 59](https://github.com/tectonic-typesetting/tectonic/issues/59) for some discussion.

docs/src/resources/README.md

@@ -0,0 +1,4 @@
+# Resources
+
+A collection of recipes and tips relating to working with tectonic.
+