An open API service indexing awesome lists of open source software.

https://github.com/cid198988/render-template

CLI tool for rendering templates with custom data templates
https://github.com/cid198988/render-template

aiohttp asyncio flask front gulp-plugin jinja2 json loader rails react spreadsheet templates underscore webpack

Last synced: 5 days ago
JSON representation

CLI tool for rendering templates with custom data templates

Awesome Lists containing this project

README

        

# Render Template ✨

![GitHub release (latest by date)](https://img.shields.io/github/v/release/cid198988/render-template?style=flat-square) ![GitHub](https://img.shields.io/github/license/cid198988/render-template?style=flat-square)

Welcome to the **Render Template** repository! This CLI tool helps you render templates using custom data templates. Whether you're a developer, designer, or just someone who loves automating tasks, this tool can simplify your workflow.

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
- [Releases](#releases)
- [Contact](#contact)

## Introduction

The **Render Template** tool allows you to create and manage templates easily. You can replace placeholders in your templates with actual data, making it perfect for generating reports, emails, or any other document that requires customization.

## Features

- **Simple CLI Interface**: Easy to use command-line interface.
- **Customizable Templates**: Use your own templates and data structures.
- **Fast Rendering**: Quickly generate output without any delays.
- **Cross-Platform**: Works on Windows, macOS, and Linux.
- **Flexible Data Input**: Supports JSON, YAML, and other formats.

## Installation

To get started, you need to download the latest release. Visit the [Releases section](https://github.com/cid198988/render-template/releases) to find the appropriate file for your system. Once downloaded, execute the file to install the tool.

## Usage

After installation, you can start using the tool right away. The basic command structure is:

```bash
render-template
```

Replace `` with the path to your template and `` with the path to your data file.

### Example Command

```bash
render-template my-template.txt my-data.json
```

This command will take `my-template.txt` and replace its placeholders with the data from `my-data.json`.

## Examples

### Basic Template

Consider a simple template file named `greeting.txt`:

```
Hello, {{name}}!
Welcome to {{place}}.
```

And a corresponding data file `data.json`:

```json
{
"name": "Alice",
"place": "Wonderland"
}
```

Running the command:

```bash
render-template greeting.txt data.json
```

Will produce the output:

```
Hello, Alice!
Welcome to Wonderland.
```

### Using YAML

You can also use YAML files for your data. Here’s a sample YAML file `data.yaml`:

```yaml
name: Bob
place: Wonderland
```

Run the command:

```bash
render-template greeting.txt data.yaml
```

This will output:

```
Hello, Bob!
Welcome to Wonderland.
```

## Contributing

We welcome contributions! If you have suggestions, improvements, or bug fixes, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add new feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a Pull Request.

Please ensure your code adheres to the coding standards and includes tests where applicable.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Releases

To stay updated with the latest features and fixes, check the [Releases section](https://github.com/cid198988/render-template/releases). Download the latest version and start using it today!

## Contact

For any questions or feedback, feel free to reach out. You can open an issue in the repository or contact me directly via email.

---

Thank you for using **Render Template**! We hope it makes your templating tasks easier and more efficient. Happy rendering!