readme_config_includer

command
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 2, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

This comes from the InfluxData, it is MIT licensed.

This is a tool to embed configuration files into the README.md of all plugins It searches for YML sections in the plugins' README.md and detects includes specified in the form

```yml [@includeA.conf[ @includeB[ @...]]
    Whatever is in here gets replaced.
```

Then it will replace everything in this section by the concatenation of the file `includeA.conf`, `includeB` etc. content. The tool is not stateful, so it can be run multiple time with a stable result as long as the included files do not change.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL