feat(readme): add headings and descriptions to text.readme
This commit is contained in:
parent
9b54a02eaa
commit
145200480d
4 changed files with 29 additions and 13 deletions
14
README.md
14
README.md
|
@ -1,9 +1,13 @@
|
|||
# readme
|
||||
## generated-files
|
||||
# Pantheon
|
||||
This flake serves as a monorepo for my systems (using IaC), dotfiles, and scripts.
|
||||
|
||||
## Generated Files
|
||||
This flake uses the [files flake-parts module](https://flake.parts/options/files.html) to generate documentation.
|
||||
The list of generated files are:
|
||||
- [docs/cheatsheet.md](docs/cheatsheet.md)
|
||||
- [README.md](README.md)
|
||||
## helpers
|
||||
### text-helper
|
||||
The option `text.<name> supports either a string or a submodule with attributes order and parts. The parts attribute can either be a string, which will get concatenated in the order laid out in `text.<name>.order`, or can itself have the attributes order and parts, in which case it will be evaluated recursively.
|
||||
## Helpers
|
||||
The following are some helpers for the repo as a whole.
|
||||
### Generating Text
|
||||
The option `text.<name>` supports either a string or a submodule with attributes order and parts.
|
||||
The parts attribute can either be a string, which will get concatenated in the order laid out in `text.<name>.order`, or can itself have the attributes order and parts, in which case it will be evaluated recursively.
|
Loading…
Add table
Add a link
Reference in a new issue