Giter Club home page Giter Club logo

docgenspec's Introduction

DocGenSpec

Is a template/scaffold for creating DocGen specifications. This allows sharing templates that generate particular types of documents, like invoices, CVs.

Usage

This template provides an example of creating a simple invoice from a markdown file.

gomplate --config=configs/default.yaml

Creating a Spec

All valid DocGenSpecs should be able to generate a document from example data. So users should be able to duplicate ./data/example.json and create a personalized document.

You can provide more than one template but at least one named default.FILE_EXTENSION should be defined. This can be an HTML, Markdown or any other file type supported by gomplate.

Note that DocGen will only search for configs so for every template there should be a corresponding config, this might change in the future but is an easy way to manage templateswithout overcomplicating the DocGen script to account for every combination of config and template.

More datasources may be defined in the configuration, see the docs for possible datasources. Where possible define an example datasource and be ware of user privacy.

Folder structure

├── configs
│   └── default.yaml (required)
├── data
│   └── example.json (required)
├── scripts
│   ├── doc_gen_cleanup.sh (optional)
│   └── doc_gen_file_name.sh (optional)
└── templates
    └── default.md (required)

Requirements

List all the required binaries or libraries that your template requires.

docgenspec's People

Contributors

danielcardonarojas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.