gendoc

Simple document generator with template yaml file

Usage

Run gendoc with gendoc.yaml file

$ cat gendoc.yaml
filename: test_<datetime>.rb
body: |
  # frozen_string_literal: true

  require 'json'

  puts JSON.parse("{}")
$ gendoc
Document generated: ./test_20200927023752.rb
$ cat test_20200927023752.rb
# frozen_string_literal: true

require 'json'

puts JSON.parse("{}")
$ ruby test_20200927023752.rb
{}

Settings

There are some setting parameters.

Meta tags

There are some meta tags which are converted on generation time.

To get more info abount format string, see here.

Multiple settings

Here's a sample gendoc.yaml to set multiple settings.

sample1:
  filename: sample1.txt
  body: |
    this is a 1st setting
saple2:
  filename: sample2.txt
  body: |
    this is a 2nd setting

Run gendoc with a setting name.

$ gendoc sample2
Document generated: sample2.txt
$ cat sample2.txt
this is a 2nd setting

TODO

• Be able to set argument to <input> tag. (<input> with the same argument will be filled with the same value.)