markloop
v0.1.0
Published
MarkLoop is a local CLI and browser UI for iterative Markdown review.
Maintainers
Readme
MarkLoop
markloop is a local CLI plus browser UI for reviewing Markdown in iterative rounds.
Install
npm install -g markloopUsage
Create a review task from a Markdown file:
markloop create path/to/file.mdCreate a review task from stdin:
printf '%s' "$MARKDOWN" | markloop createRead annotations for an existing task:
markloop get <taskId>Start another review round from an existing task:
markloop update <taskId> path/to/file.mdConfigure the host used in generated review URLs:
markloop set host your-machine.tailnet.ts.netStart the local MarkLoop server:
markloop serve [port]Release flow
This repository publishes the markloop package to npm from GitHub Actions when a Git tag matching v*.*.* is pushed.
- Update
package.jsonto the target version. - Commit the release change.
- Create a matching tag, for example
v0.1.0. - Push the commit and tag to GitHub.
- GitHub Actions runs
.github/workflows/publish.yml, verifies the tag matchespackage.json, runsnpm ci,npm test,npm run build,npm pack --dry-run, and then publishes the package.
npm publish permissions
The workflow currently publishes with an npm token stored as a GitHub repository secret named NPM_TOKEN.
For the first release:
- Create an npm token that is allowed to publish packages.
- Add it to the GitHub repository as the
NPM_TOKENActions secret. - Push a matching release tag such as
v0.1.0.
This repository currently publishes with an npm token and without provenance because npm only accepts GitHub Actions provenance from public source repositories.
If you later make the repository public, you can re-enable provenance or migrate to npm trusted publishing for better security:
- GitHub organization or user:
parkgogogo - Repository:
web-reviewer - Workflow filename:
publish.yml
The workflow file already lives at .github/workflows/publish.yml.
Trusted publishing is a good follow-up hardening step, but npm only allows configuring it for packages that already exist in the registry.
