Everkm Publish
Take Your Knowledge from Markdown to the World
everkm-publish (Everkm Publish) is a Markdown static site generator in the Everkm ecosystem.
Turn your notes, knowledge base, product documentation, and blog content into high-performance static websites through themes.
No database required. No complex deployment.
Write Markdown. Build lasting content assets.
Markdown Content
+
Theme Template
=
Static HTML Website
=
CDN / Any Static Hosting
What Can You Build?
| Use Case | Purpose |
|---|---|
| Product Website | Publish product introductions, help docs, changelogs |
| Technical Documentation | Build Wiki, developer manuals, knowledge bases |
| Personal Blog | Record growth, experiences, and work over time |
| Content Site | Publish structured content and attract search traffic |
From Writing to Publishing
Everkm Publish fully separates:
- Content creation
- Site structure
- Page design
- Publishing and deployment
All you need to do is:
- Write content in Markdown
- Choose a theme
- Preview locally
- Export a static site
Writing
=
Organizing Knowledge
=
Generating Pages
=
Search Discovery
=
Long-term Accumulation
Core Capabilities
Content and Theme Separation
The content body is only responsible for content.
Page structure, layout, and styles are controlled by the theme.
Official themes available:
You can also:
- Fork an official theme
- Modify existing templates
- Create your own theme
Theme development is based on the Tera template engine, compatible with Jinja2 syntax.
Flexible Site Structure
Unlike traditional blogs with fixed structures:
Home
├── Categories
├── Articles
└── Pages
Everkm Publish defines content relationships through directory configuration.
You can build:
- Product documentation
- Knowledge maps
- Wiki
- Multi-level resource libraries
- Personal knowledge websites
Site structure is determined by your content.
See also:
Everkm Markdown
Extensions on top of standard Markdown:
[[page]]internal knowledge links- Macro functions
- dCard content cards
_nav.mdchapter navigation
Transform Markdown from simple articles into a connected knowledge network.
See also:
Fast Preview and Static Export
Development mode:
everkm-publish serve
Preview content changes in real time.
Publish:
everkm-publish serve --export
Automatically generates a complete static site.
Supports:
- HTML output
- Image resource synchronization
- Internal link resolution
- Static deployment
Deploy to:
- CDN
- GitHub Pages
- Any static hosting service
Built for Search
Content only creates value when it is discovered.
Everkm Publish optimizes the search experience end-to-end, from generation to publishing.
SEO-Friendly Static Pages
Export results:
- Standard HTML
- No runtime dependencies
- Directly crawlable by search engines
Each Markdown file supports:
title:
description:
keywords:
Automatically generates:
- Page title
- Meta description
- Search snippet information
On-Site Full-Text Search
Official theme support:
Full-text search capabilities:
- Instant search
- Multi-language indexing
- Automatic synchronization
- CI auto-push
Give your knowledge base an app-like search experience.
See also:
Multi-Language Support
Content is organized by language directories:
content/
zh_CN/
en_US/
UI text configuration support:
@i18n:
Easily build internationalized sites.
See also:
Theme Ecosystem
Everkm Publish does not limit website form.
Supports:
- Remote theme installation
- Local ZIP installation
- Custom templates
- Site extensions
Themes can grow alongside your content.
See also:
Quick Start
Install:
brew install everkm/tap/everkm-publish
Create a site:
mkdir my-site
everkm-publish init my-site
cd my-site
Start the preview:
everkm-publish serve
Open:
http://localhost:9081
Start building your first knowledge site.