shine
Terminal Markdown previewer and docs checker for READMEs, changelogs, and release notes.
Tested on macOS and Linux
Use it
macOS arm64
You need first
- Runtimes:
Go 1.24.2 or newer,Node.js 18+
npm install -g @nk02/shine@0.1.2
npm install -g @nk02/shine@0.1.2 && shine version
Check that it works
shine versionThe output should contain “0.1.2”.
First thing to try
shine versionRun shine README.md in a folder with a README to open the interactive preview.
Linux x86_64
You need first
- Runtimes:
Go 1.24.2 or newer,Node.js 18+
install shine via npm
npm install -g @nk02/shine@0.1.2
Check that it works
shine versionThe output should contain “0.1.2”.
First thing to try
shine versionRun shine README.md in a folder with a README to open the interactive preview.
What it does
- Preview Markdown in the terminalTested
How to use it
- Run
shine --plain <file>to print a Markdown file as plain text.
- Run
- Browse a preview with search and an outlineTested
How to use it
- Run
shine --outline <file>to show the document's heading outline.
- Run
- Check docs for publishing issuesTested
How to use it
- Run
shine --check <file>to list Markdown warnings for the file.
- Run
- Show local images inline in the terminalNot shown working
How far pickfit got
macOS arm64
- Installs
- Starts
- 3 of 4 features work
- Works offline
Linux x86_64
- Installs
- Starts
- 3 of 4 features work
- Works offline
Other systems
Good for
- preview a README in the terminal
- check README for common docs issues
- show document heading outline
- print plain text output without styling
- preview Markdown from stdin
How pickfit tested it
Each run starts from a clean machine and follows the steps above. How pickfit verifies
macOS arm64
Its main function works
- Replayed from scratch
- Works offline
- Checked on 1 Nov 2026
- Version 0.1.2
Linux x86_64
Its main function works
- Replayed from scratch
- Works offline
- Checked on 1 Nov 2026
- Version 0.1.2
Differences the test machine hit
- README: shine --check README.md returns docs warnings
In the test: exit code 2 when warnings found (not 0) – expected behavior per --help