Generate portable terminal based documentation.
I will soon turn it into a module so it will ease the generation
For now you can simply clone
this repository and modify the content of the ./docs
folder.
Altair supports nested folders.
Run:
pnpm dev
or
pnpm build
The building process
is simple.
- It first walks the
./docs
directory - Generates a new file with all the computed content (like a db)
- Builds
Altair builds the tree from the generated content (and not from the os.Readir
or os.Walkdir
or whatnot)
Write your stuff in .txt
-
Add colors: altair is based on Tview so it supports its coloring syntax
[COLOR]something[RESET]
for example if I wanted to colorHello world
in orange I'd write[orange]Hello world[white]
-
Add snippets: (for now only one snippet per
.txt
) simply wrap the file name, that contains the snippet, within-
signs
for example if I wanted to import snippethello.wat
, I'd writeI'm now importing hello.wat content \- hello.wat \- done!
Altair will replace it with the file content
IMPORTANT: files must be in the same dir (working on it)
Quit:
Press q
to quit.
There's the possibility to switch between light and dark theme (by clicking the buttons)
As for now it is still an MVP
- Search (search in the docs)
- Simplify the process
- Run snippets