feat: Working on documentation

This commit is contained in:
2024-12-06 17:01:11 -05:00
parent f0873d3b44
commit 1a559e0236
11 changed files with 191 additions and 73 deletions

View File

@@ -0,0 +1,30 @@
# ``CliDocCore``
A framework for writing `cli` documentation in a way similar to `SwiftUI`, where
your types conform to ``TextNode`` and implement a ``TextNode/body`` that
returns a ``TextNode``, generally using the essential types described below.
## Topics
### Essentials
- ``VStack``
- ``HStack``
- ``Section``
- ``Group``
- ``Empty``
- ``AnyTextNode``
### Styling
- ``SectionStyle``
- ``DefaultSectionStyle``
- ``SectionConfiguration``
- ``TextStyleConfiguration``
### Base Protocols
- ``TextNode``
- ``TextNodeRepresentable``
- ``TextStyle``
- ``TextModifier``

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB