Skip to content

⭐✨ Generate portable terminal based documentation. Build the binary and read them from anywhere.

Notifications You must be signed in to change notification settings

thomscoder/altair

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Altair ⭐

Generate portable terminal based documentation.

How to use

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.

Screenshot-2022-12-04-alle-17-14-02

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 color Hello 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 snippet hello.wat, I'd write

    I'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.

Light/Dark theme

There's the possibility to switch between light and dark theme (by clicking the buttons)

Screenshot-2022-12-04-alle-17-13-48


Roadmap

As for now it is still an MVP

  • Search (search in the docs)
  • Simplify the process
  • Run snippets

About

⭐✨ Generate portable terminal based documentation. Build the binary and read them from anywhere.

Topics

Resources

Stars

Watchers

Forks

Languages