feat(readme): add headings and descriptions to text.readme

This commit is contained in:
Mohammad Rafiq 2025-07-05 04:53:59 +08:00
parent 9b54a02eaa
commit 145200480d
No known key found for this signature in database
4 changed files with 29 additions and 13 deletions

View file

@ -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.