Generate documents

Create any type of document from structured data in formats such as json.

Use tools like pandoc to post process files and convert to other formats.

Requirements

Installation

git -C ~/.local/bin/ clone https://github.com/DanielCardonaRojas/docgen 
ln -s ~/.local/bin/docgen/docgen /usr/local/bin

Usage

Run the docgen cli:

docgen

This will list all the available document generators with fzf and other options to choose from. select you're preferred configuration and a file should be generated in your current working directory or to `stdout.

Using DocGenSpec (document generator)

DocGenSpecs provide all necessary files to generate a specialized document.

Clone or create a DocGenSpec.

./scripts/clone.sh GITHUB_URL

./scripts/scaffold.sh SPEC_NAME

Environment variable

DocGen will install and search for DocGenSpecs at $DOCGEN_PATH which defaults to $HOME/.config/docgen if not set.

System

graph TD
    subgraph DocGen System
        subgraph DocGenSpec
            Templates[Templates]
            DataFiles[Data Files]
            Scripts[Scripts]
        end

        subgraph Index
            IndexData[DocGenSpecs]
        end

        subgraph docgen
            gomplate
        end

        subgraph FileSystem
            CustomData[Custom Data Dir]
            DownloadData[Download DocSpec Dir]
        end


        docgen --->|Downloads| DocGenSpec
        docgen --->|Creates| CustomData
        DataFiles <---|Mirrors| CustomData

        Index --->|Stores| DocGenSpec
        docgen --->|Searches| Index


        Documents[Generated Documents]

        Templates --> Documents
        DataFiles --> Documents
        Scripts --> Documents
    end

DanielCardonaRojas/docgen

README