feat: Working on documentation
This commit is contained in:
30
Sources/CliDocCore/Documentation.docc/CliDocCore.md
Normal file
30
Sources/CliDocCore/Documentation.docc/CliDocCore.md
Normal 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``
|
||||
BIN
Sources/CliDocCore/Documentation.docc/Resources/section.png
Normal file
BIN
Sources/CliDocCore/Documentation.docc/Resources/section.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.6 KiB |
Reference in New Issue
Block a user