Skip to content

Repository files navigation

doc-builder

doc-builder is a framework for interpolating files into documents.

The primary motivation was to allow source code samples in markdown documents to have automated testing.

Example

The following is the config file that created this README.md document:

{
  "variables": {
    "project_name": "doc-builder"
  },
  "targets": [
    {
      "template": "README.tmpl.md",
      "output": "README.md",
      "inputs": [
        "assets/intro.md",
        "dbc.json"
      ]
    },
    {
      "output": "dbc.json",
      "filter": "sed 's/\t/  /g'"
    }
  ]
}

Builds

Release builds can be found at https://github.com/christopherfujino/doc-builder/releases.

For example: https://github.com/christopherfujino/doc-builder/releases/download/v0.5/db-0.5-linux-arm64.tar.gz.

About

Build and maintain docs from tested external source files.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages