Skip to content

Lil CLI helper tool to generate mdx for the Figura Wiki.

License

Notifications You must be signed in to change notification settings

joeyleesi/thingy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Thingy

Lil CLI helper tool to generate mdx for the Figura Wiki. Sorry some stuff is messy! Feel free to contribute :D

Installation

  1. Install Rust.

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  2. Clone the repo

    git clone https://github.com/joeyleesi/thingy.git
  3. Navigate into the projects directory and build

    cd thingy
    cargo build --release
  4. All set! You can find the binary at build/release/thingy

Usage

Usage: thingy --input <FILE> <COMMAND>

Commands:
  generate  Generate documentation for the given pages
  pages     List the possible pages to generate
  types     List the possible types used in the documentation (useful for creating link map)
  help      Print this message or the help of the given subcommand(s)

Options:
  -i, --input <FILE>  Path to the exported_docs.json file
  -h, --help          Print help
  -V, --version       Print version

Examples

  • List all the possible pages that can be generated

    ./thingy -i path/to/your/exported_docs.json pages
  • Generate a page

    ./thingy -i path/to/your/exported_docs.json generate -p Action
  • Generate a page and save to a file

    ./thingy -i path/to/your/exported_docs.json generate -p Action > Action.md

About

Lil CLI helper tool to generate mdx for the Figura Wiki.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages