After confirming everything looks correct in the preview, export the static site and deploy it online.
Exporting a Static Site
Run in the workspace root directory:
cd my-site
everkm-publish serve --export
Starting from the default entry /index.html, it crawls the rendered pages, saves HTML by URL path, and follows inner links until traversal is complete. Resources referenced in the content, such as images, audio, and video, are exported along with the pages; unreferenced resources are not exported.
Export-related options (--dist-dir, --start-urls, --with-vercel, etc.) can be found in everkm-publish serve --help.
Adding Resources Before Export
Place files that are not referenced in body text but need to be published via __everkm/extend/:
| Directory | Purpose |
|---|---|
extend/assets/ | Copied to site assets/; takes priority over theme assets during preview |
extend/pages/ | After export completes, overwrites HTML at the same path (e.g., custom 404.html) |
Existing target files will be overwritten.
Pre-publish Check
everkm-publish lint ./my-site
everkm-publish lint ./my-site --auto-fix
Checks Front Matter (id, created_at, slug uniqueness, etc.) and body [[...]] inner links. Field descriptions can be found in Article Metadata. For more options, see everkm-publish lint --help.
Verifying Export Results
Start a local HTTP server on the exported static directory:
everkm-publish web ./dist
Confirm in your browser that links and resources work correctly, then upload and deploy.
Deployment Options
The export directory is a ready-to-deploy static site root:
| Method | Description |
|---|---|
| Object Storage + CDN | Upload all files from dist/ to OSS / S3, etc., and bind a domain |
| Nginx | Set root to the export directory; add --with-nginx-map during export |
| Vercel | Add --with-vercel during export, deploy with the generated configuration |
| Any Static Hosting | GitHub Pages, Cloudflare Pages, etc. |
Recommended workflow before deployment: lint → serve --export → web ./dist local verification → upload.
For issues, see FAQ.
Full-text Search (Optional)
If using Algolia, push the index after export and configure the theme search parameters in everkm.yaml. See Embedded Search.