Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/echamudi/markomatic
Generate Markdown files using partial templates and YAML configuration
https://github.com/echamudi/markomatic
Last synced: 4 days ago
JSON representation
Generate Markdown files using partial templates and YAML configuration
- Host: GitHub
- URL: https://github.com/echamudi/markomatic
- Owner: echamudi
- License: mpl-2.0
- Created: 2019-09-26T08:31:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:01:14.000Z (about 2 years ago)
- Last Synced: 2024-11-22T04:15:50.283Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 220 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markomatic
Generate Markdown files using partial templates and YAML configuration
## Usage
Install markomatic
```
npm install -g markomatic
```
Create your template file, e.g. `document.template.md`
```md
# Hello
It's {{ name }}, I like {{ hobby }}.
## Fruits
My favourite fruits are:
{% for fruit in fruits %}
- {{ fruit }} {% endfor %}
```
Create your markomatic config file, e.g. `markomatic.yaml`
```yaml
markomatic :
input: ./document.template.md
output : ./document.md
variables :
name : John
hobby : programming
fruits :
- Apple
- Orange
- Avocado
- Melon
```
Run the markomatic generator
```sh
$ markomatic ./markomatic
```
That's all! Check the output at `./document.md`
```md
# Hello
It's John, I like programming.
## Fruits
My favourite fruits are:
- Apple
- Orange
- Avocado
- Melon
```
## Contributing
This project is following [git-flow branching model](https://github.com/echamudi/echamudi-docs/blob/master/git-strategy/gitflow.png).
- Please create a branch from `develop`.
- Name it something descriptive other than `master`, `develop`, `release-*`, or `hotfix-*`.
- Open a pull request to `develop`.
Make sure your contributions are compatible with the license of this code.
## Development
| Branch | Status |
| - | - |
| master | [](https://travis-ci.org/echamudi/markomatic) |
| develop | [](https://travis-ci.org/echamudi/markomatic) |
The development of this project is following [gitflow](https://github.com/nvie/gitflow) branching model.
## License
Copyright © 2019 Ezzat Chamudi
Markomatic code is licensed under [MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/).
Libraries, dependencies, and tools used in this project are tied with their licenses.