Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@archway/clio) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Clio

CLI tools for linking and managing glossaries in markdown projects. Works well with Vitepress or by itself. Clio is not intended to be imported directly into code. Clio modifies markdown files in a folder.

Quick Start

npm i -g @archway/clio

cd to the parent folder of your documentation project.

CLI commands run for all relevant markdown files within the folder.

Command	Purpose	Example
`clio add`	Add a new glossary entry	`clio add`
`clio`	Create and update glossary links	`clio` or `clio gloss`
`clio rename`	Rename glossary entries, recursively updating all docs pages	`clio rename`
`clio search`	Fuzzy find a definition with a substring	`clio search Variant`
`clio stats`	View at-a-glance stats about the project	`clio stats`
`clio help`	View syntax and help	`clio help`

Stabilty and Roadmap

⚠️ Heads up!
This project is in late-stage beta — it's stable and actively used, but still evolving.
Expect one final round of breaking changes before we lock in version 1.0.0.

We’ll follow semantic versioning, so major changes will be clearly versioned.
If you're integrating this into production workflows, consider pinning to an exact version (0.x.y) to avoid surprises.

Contributing

Clio is authored by 0xbenc.

_{Charles Meynier – Clio, Muse of History (Cleveland Museum of Art)}