https://github.com/jtemporal/autogenfiles_playground

Collection of examples for the AutoGenFiles package
https://github.com/jtemporal/autogenfiles_playground

Last synced: 4 months ago
JSON representation

Collection of examples for the AutoGenFiles package

• Host: GitHub
• URL: https://github.com/jtemporal/autogenfiles_playground
• Owner: jtemporal
• License: mit
• Created: 2021-07-24T18:48:37.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-07-24T19:50:05.000Z (almost 5 years ago)
• Last Synced: 2025-01-12T18:35:27.728Z (over 1 year ago)
• Homepage: http://jtemporal.com/autogenfiles/
• Size: 5.86 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# AutoGenFiles Playground

AutoGenFiles collection of examples.

## How to use this repo

Install autogenfiles, go into the example you want to see then run the command outlined in said example REAME.md

 

### Examples

#### Operation Simplicity

The simplest use case possible: `templates/` has only files to be rendered, variables file follow the default naming, and output go in the root of project.

```console

operation_simplicity

├── OperationSimplicity.md  -> automatically generated from templates folder

├── README.md               -> general instructions

├── templates               -> templates folder

│   └── {{ project_name }}.md

└── variables.yaml          -> variables file

```

#### Operation Subfolders

This time `templates/` has a subfolder structure that needs to be followed, the output go in the root but follow the subfolder structure from `templates/`, and variable files has a non-default naming.

```console

operation_subfolders

├── REAME.md          -> general instructions

├── _posts            -> atomatically generated from templates folder

├── projects          -> automatically generated from templates folder

├── templates         -> templates folder

│   ├── _posts

│   └── projects

└── variables.ini     -> variables file

```

#### Operation Rendered

The most complex case so far: `templates/` has a subfolder structure that needs to be followed, the output goes into an output directory called `rendered/` that follows the subfolder structure from `templates/`, and variable file has a non-default naming.

```console

operation_rendered

├── REAME.md       -> general instructions

├── rendered       -> automatically generated from templates folder

│   ├── _posts

│   └── projects

├── templates      -> templates folder

│   ├── _posts

│   └── projects

└── variables.ini  -> variables file

```