Clio

CLI tools for linking and managing a glossary for documentation. Works well with Vitepress or by itself.

Clio is not intended to be imported into code files.

Clio modifies markdown files in a folder, via terminal.

Quick Start

npm i -g @archway/clio

cd to the parent folder of your documentation project

clio init

Automatic Glossary Suggestions

clio suggest

Add a glossary entry

clio add

Propogate links to glossary

clio

Reference

| Command | Purpose | Example | |---------|---------|---------| | clio init | Creates a clio project folder at the top directory of docs | clio init | | clio suggest | Suggests words from user's docs to add to glossary | clio suggest | | 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 toc | Rebuilds the Glossary Table of Contents | clio toc | | clio delink | Remove all md links to other local md files | clio delink | | clio help | View syntax and help | clio help |

Stabilty and Roadmap

Clio follows Semantic Versioning (semver).

• Patch (x.y.Z): Bug fixes or internal improvements with no impact on usage.
• Minor (x.Y.z): New features that don’t break existing behavior.
• Major (X.y.z): Breaking changes to commands, options, or output formats.`

The config.json created in the .clio folder when running

clio init

also contains a schema version number for potential future breaking data migrations.

Contributing

Clio is authored by 0xbenc.