Skip to content

Static website compiler with markdown, charts and graphs support

License

Notifications You must be signed in to change notification settings

nirname/documentary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentary

Static website compiler with markdown, charts and graphs support.

Converts simple text notation into pretty looking pages.

It doesn't pretend to be a new tool, it is just convenient union of other great tools.

Right now it includes:

  • Markdown extended from Pandoc
  • All the types of graphs that Graphviz supports
  • Flowchart diagramms via Seqdiag
  • Embedded and standalone images

Getting Started

  1. Install Docker

  2. Create new project or add existing folder

    docker run --rm -it -v $(pwd):/local nirname/documentary init project

    then cd project.

    Or cd project first, then:

    docker run --rm -it -v $(pwd):/local nirname/documentary init .

    You can also configure source (src) and destination (docs) folder names, as well as your domain (CNAME).

    Full command example:

    docker run --rm -it -v $(pwd):/local nirname/documentary init project src docs my.website

    Your configuration will be saved in nenv.

  3. Build your project

    Put some markdown in your source folder and:

    ./ndoc build

As simple as that.

How to use it

To create an embedded graph add class to a code block:

# Sample

```dot
digraph {
    A->B
}
```

Regarding standalone images a file with proper extension like sample.dot will be converted to sample.dot.svg.

Create a graph file:

echo "digraph { A->B }" > src/sample.dot

and add it to your markdown

![Sample](sample.dot.svg)

Supported classes (they are extensions also) are:

  • dot - Graphviz 'dot'
  • neato - Graphviz 'neato'
  • fdp - Graphviz 'fdp'
  • sfdp - Graphviz 'sfdp'
  • twopi - Graphviz 'twopi'
  • circo - Graphviz 'circo'
  • seqdiag - Blockdiag 'seqdiag'

Styles

Currently, all the css are automatically included. Put some *.css files under source folder, then build.

For instance, you can download Github markdown styles.

Code syntax highlight comes from Pandoc.

Structure of the project

  • bin - executables
  • plugins - things that enhance and extend markdown
  • templates - self-descripting, this will be used as scaffold and put within project
  • docs - documentation

Join the Development

I would really appreciate any assistance so as to increase amount of diagrams and simplify usage.

Acknowledgements

The very idea of implementation is borrowed from here

The idea of using inline dot graphs shamelessly taken from here