The authoritative source for CLI parameters is everkm-publish's built-in --help; the documentation only describes each command's role in the publishing workflow.
everkm-publish --version
everkm-publish --help
everkm-publish serve --help
everkm-publish lint --help
everkm-publish theme install --help
Subcommand Overview
| Command | Role in the Publishing Workflow |
|---|---|
init <site-root> | Initialize __everkm/, install default theme |
serve | Local preview; add --export to export static site |
lint <path> | Pre-publish check for Front Matter and internal links |
web <directory> | Locally preview an exported static directory |
theme install <theme> | Install or update a theme package |
file-meta <file> | Debug a single Markdown file's parsed result (JSON) |
Theme Name Reference
| Scenario | Syntax | Description |
|---|---|---|
init default | --theme youlog (can be omitted) | After installation, directory is __everkm/theme/youlog/ |
serve preview | everkm-publish serve or --theme youlog | Matches init default |
| Remote install | theme install everkm/youlog@version | Remote package name includes author prefix |
For remote installation and switching, see Quick Start.
Read by Scenario
| What you want to do | Documentation |
|---|---|
| First preview | Quick Start |
| Export and deploy | Export and Publish |
| Front Matter / lint | Article Metadata, Export and Publish |
| Algolia search | Embedded Search |
| Theme development | Theme Development |
| Troubleshooting | FAQ |
The standalone tool ekmp-algolia (index push) is described at Embedded Search; parameters at ekmp-algolia --help.