The demo admin username and password are both demo. The documentation and application interface are currently primarily in Chinese; internationalization is on the roadmap.
Preview
Features
- A complete blogging system. A public blog, admin dashboard, and backend API, with responsive layouts and automatic light/dark modes for both readers and authors.
- Static pages with incremental updates. The Next.js frontend uses static generation (SSG) and incremental static regeneration (ISR), so content changes do not require rebuilding every page. Pages are CDN-friendly, with lazy-loaded images, customizable article URLs, and support for SEO and accessibility.
- Markdown publishing. A ByteMD editor with Mermaid diagrams, mathematical formulas, custom highlight blocks, an emoji picker, and a shortcut for the
more marker. Upload local or clipboard images directly from the editor, import Markdown files, and manage posts and drafts in bulk.
- Tools for readers. Tables of contents, code copying, categories, tags, search, password-protected articles and categories, friend links, donation links, custom navigation, and RSS feeds.
- Built-in analytics. Visitor statistics and dashboards, plus support for Google Analytics and Baidu Analytics.
- Integrated comments. Waline comments with email notifications and webhooks.
- Image hosting. Built-in image storage and external storage through PicGo, including object storage and GitHub. Images can be compressed and watermarked on upload.
- Customization. Layout settings, custom pages, and custom CSS, HTML, and JavaScript. Extensions can run custom code or call webhooks after selected events. A full theme system and plugin system remain planned work.
- Collaboration and APIs. Collaborator accounts with configurable permissions, token management, and APIs for building a separate frontend or integrating another page generator.
- Deployment and operations. A guided installation script, Docker deployment with AMD64 and ARM64 support, and automatic on-demand HTTPS certificate issuance and renewal through Caddy. The admin dashboard provides import/export, version and update notices, and access to login and Caddy logs.
Maintenance and releases
VanBlog uses an automated AI maintenance workflow to reproduce reported code issues, add regression tests, and open pull requests, with corresponding changelog and documentation updates. The maintainer remains responsible for merging into master and creating release tags. Issues and pull requests are welcome.
Product releases and deployments are triggered by v* tags; documentation deployments are triggered by doc* tags. The live demo and documentation site stay on their latest tagged versions, so they may not yet reflect changes on master.
If you encounter a problem, first check whether it is resolved in the latest published release.
Quick start
Install with the setup script
curl -L https://vanblog.mereith.com/vanblog.sh -o vanblog.sh && chmod +x vanblog.sh && ./vanblog.sh
If the documentation site is unavailable, use the GitHub raw mirror:
curl -L https://raw.githubusercontent.com/Mereithhh/vanblog/master/scripts/vanblog.sh -o vanblog.sh && chmod +x vanblog.sh && ./vanblog.sh
To run the script again later:
./vanblog.sh
For other deployment options, see the getting started guide. The default Docker Compose setup runs VanBlog and MongoDB as separate services.
Reverse proxies
See the reverse proxy guide.
Common questions
Development and contributions
VanBlog is a pnpm workspace with a Next.js/React frontend, a NestJS backend using MongoDB, and a Umi/Ant Design admin dashboard. See the development guide and changelog.
Open an issue to report a problem or suggest an improvement. Reproducible code issues enter the automated AI investigation and pull request workflow. Requests to add a site to the showcase are handled by the maintainer, who also handles merges and releases.
Roadmap
Themes and internationalization are long-standing goals for making VanBlog easier to adapt and use across communities. The following items are planned and are not a list of currently available features:
Expanding end-to-end test coverage is also ongoing; server tests and admin end-to-end tests already run for pull requests.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
