https://github.com/tscpp/revise-static-content
Utility for updating static documentation in a repository.
https://github.com/tscpp/revise-static-content
Last synced: 10 months ago
JSON representation
Utility for updating static documentation in a repository.
- Host: GitHub
- URL: https://github.com/tscpp/revise-static-content
- Owner: tscpp
- License: mit
- Created: 2024-05-06T10:06:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-07T11:50:50.000Z (over 1 year ago)
- Last Synced: 2025-02-04T21:17:41.497Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 256 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Revise Static Content
```
revise-static-content
```
Managing static documentation within your repository becomes effortless with this tool, which dynamically renders content into markdown files. [Why?](#why)
## Why?
Maintaining and synchronizing content across various files can be challenging, often leading to tedious copy-pasting tasks. Consequently, updating these files later becomes a nightmare, resulting in outdated documentation.
## How it works
The package introduces "directive" comments capable of rendering content within specified tags. Since the comments themselves remain intact, the content can be dynamically re-rendered.
```html
some generated content
```
## Usage
Simply provide a glob pattern to the CLI. It will then render all dynamic content within the directives and overwrite the files accordingly.
```
revise-static-content **/README.md
```
## Directives
### Include
This directive allows for the inclusion of content (parts) from other markdown files. The included content also supports [template syntax](#templates).
```html
This code is automatically generated and should be edited elsewhere.
```
### Insert
Inserts a [template](#template) specified inline in the directive paramater.
```html
Hello John!
```
## Templates
Templates are snippets of code whose content can be overwritten. Templates can only be written in dynamic parts used by the [include directive](#include), or inline in the [insert directive](#insert). Templates allow you to insert values defined in the [frontmatter](https://jekyllrb.com/docs/front-matter/).
```
Hello {{name}}!
```
### Ignoring
You can ignore rendering templates by wrapping the content in the ignore directive.
```html
This is how you write mustache `{{name}}`!
```