kurisuwhyte/type.writer

Old-school documentation, meet Simple.

type.writer's Issues

"essay new" should create a new directory

Dumping things in the current directory has the potential to be fairly confusing and cause more problems. Thus essay new should ask for a new directory name and abort the operation if theres something with the same pathname.

Trick Linguist into ignoring vendor/ files

Apparently Github's linguist doesn't do a great job ignoring vendored files once they've taken them into account (indexed them) if you just move them around(?), so removing them and adding them back should do the trick.

Support easy installation in Unix/Windows

Allow navigation rendering format to be defined in the template

Currently the links in the navigation are only really suitable for the default template, anything straying too much from this will look meh.

Present better feedback for the user in the command line

Untangle parsing and building phases

Even though the only output format will be HTML, cleanly separating parsing and building phases will allow for a few interesting things, like automatically generating navigation links and stuff.

Make the default *log-level* :verbose

Support per-document templates

Currently the only template used is layout/index.html, which is fixed. This is not ideal. We want users to have, potentially several templates, and documents can choose which one they'll use — kind of like YAML metadata for Jekyll blogs.

The default template should be defined in the project.edn file.

Support snippets and other abstractions for templating

Implement automatic cross-references.

Sphinx has this, and it's a fairly neat stuff for API docs.

Automatically recompile documents for testing

It would be interesting to have documentation automatically recompile, without having to run essay generate at each time, which provides a nicer experience for people writing the documentation.

This could be implemented as a simple ring server.

Provide a configuration wizard to generate `project.edn`