guia
| Crates.io | guia |
| lib.rs | guia |
| version | |
| source | src |
| created_at | 2025-01-06 15:04:30.673739 |
| updated_at | 2025-01-08 21:35:42.531565 |
| description | A documentation browser for the terminal |
| homepage | https://github.com/thigcampos/guia |
| repository | https://github.com/thigcampos/guia |
| max_upload_size | |
| id | 1505694 |
| Cargo.toml error: | TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Thiago Campos (thigcampos)
documentation
README
Guia
Take a look at your favorite project documentation without leaving the terminal. Guia is a simple command line tool that allows you to read offline documentation sets.
Install
cURL
Requirements
- rustup;
- cargo;
curl -sSL https://raw.githubusercontent.com/thigcampos/guia/main/install.sh | bash -
Homebrew (macOS-only)
Guia is now available on Homebrew. You can install it using the following command:
brew install guia
If any issues arise, try to run the following command:
brew tap thigcampos/guia
How to use
To list all documentation sets available in your system, you can use the following command:
guia list
To display a documentation set, you can use the following command:
guia bun
To download a supported documentation set, you can use the following command:
guia add bun
Markdown renderer
Guia uses less as the default markdown renderer, since it's available
in widely used systems, with a few exceptions, most notably Windows.
If you want to use a different markdown renderer, you must assign a new value to GUIA_MARKDOWN.
You're free to choose any command-line tool or application that can handle markdown files, including,
but not limited to, cat, vim, code, more, and etc.
export GUIA_MARKDOWN="glow" # Recommended markdown renderer
Disclaimer: Glow is an external dependency, so you need to install it manually. It is not distributed or related with Guia.
Documentation Sets
Supported documentation sets
- Bun;
Documentation sets location
All documentation sets are stored in the docsets directory. You may find
docsets under the folder guia in your OS local config directory.
- Linux/Redox:
$XDG_CONFIG_HOMEor$HOME/.config; - macOS:
$HOME/Library/Application Support; - Windows:
{FOLDERID_LocalAppData};
guia reads docsets to display the available docs. As of now,
you may need to install desired documentation sets manually,
since we have just a few of them officially supported.
License
Guia it's released under the MIT license. However, projects documentation may not be under the MIT license, so please check the project's documentation license before using it. See LICENSE for more information.