Maxwell 文档

欢迎使用 Maxwell，一个面向博客、文档和作品集的轻量级静态站点生成器。这份文档是使用 Maxwell 构建、配置和部署站点的完整参考。

5 分钟快速开始

安装 Maxwell：

# macOS / Linux
brew install maxwell-ssg

# 或者使用 npm
npm install -g @maxwell/cli

创建一个新项目并启动本地预览：

maxwell init my-blog
cd my-blog
maxwell dev

打开浏览器访问 http://localhost:3200，你应该能看到默认主题的欢迎页。编辑 content/posts/ 下的任何 Markdown 文件，页面会自动热重载。

文档目录

• 架构概览 —— Maxwell 的内部工作原理和扩展点
• 部署指南 —— 把构建结果发布到各种平台

常用链接

• 项目首页
• 下载页
• 社区展示
• 品牌资源

获取帮助

如果你遇到问题，可以先查 GitHub Issues 里是否已经有相同的讨论，大多数常见问题都能在那里找到答案。对于开发中的新功能和路线图，可以看 GitHub Projects 看板。

贡献

Maxwell 是 MIT 协议开源项目，欢迎提 issue 和 PR。提交前请先阅读 CONTRIBUTING.md 了解代码规范和测试要求。