marcaddeo / docdoc Goto Github PK

This should preserve the full document path and not strip out the first component.

docdoc --preserve-first-component docs/some/path/example.md docs/dist should output docs/dist/docs/some/path/example.md

Need to be able to support images within content.

Set up a simple site that just outputs the README for now.

Implement a --extra-metadata flag to pass metadata in through the command line.

This should work a lot like Ansible's --extra-vars flag, and similarly will take precedence over all metadata.

YAML

docdoc --extra-metadata="title: Something" -e "subtitle: something" docs/example.md docs/dist

YAML file

docs/navigation.yml

navigation:
  - name: Home
    path: /index.html
  - name: About
    path: /about.html

docdoc --extra-metadata="@docs/navigation.yml" docs/about.html docs/dist

In order to be able to link to other documents, we need to convert .md links into .html

The failure crate is supposed to supercede the error_chain crate for handling errors. Might be wise to get this in before 1.0.0 to avoid large breaking changes.

Would likely be nice to be able to do something like:

name: example_theme

metadata:
  - title: Default title
  - include: @navigation.yml

assets:
  - assets

Create a simple default theme that should be distributed with docdoc. It should look pretty, and include an optional navigation.

Create a couple examples on using docdoc:

• Single document
• Single document with a navigation
• Simple static website