快速上手

Methanol 可将包含 Markdown/MDX 的目录直接转化为具备完整路由、导航及构建流程的静态站点。

几无配置门槛：只需创建 pages/index.mdx 并逐步添加文件或目录，路由与导航即可自动生成并实时更新。

快速体验

如需快速体验，可直接通过 npx 运行：

npx methanol dev

随后访问 http://localhost:5173。

使用现有 Markdown 目录

若你已有一份 Markdown/MDX 文档目录，可直接指定该目录：

npx methanol dev ./my-docs

该目录将作为内容根目录，例如 ./my-docs/index.mdx 将映射至 /。

提升本地开发效率

若需频繁使用，建议进行全局安装以提升启动速度：

npm install methanol -g
methanol dev

生产构建

npx methanol build
npx methanol serve

serve 命令将基于 dist/ 中的产物启动本地预览。

项目结构

pages/        # MDX/MD 页面（亦可使用 docs/）
components/   # 可在 MDX 中使用的 JSX/TSX 组件
public/       # 静态资源（将覆盖主题默认资源）
build/        # 中间 HTML 文件（可选）
dist/         # 生产环境输出产物

public/ 目录下的文件将服务于根路径 /（例如 public/logo.png → /logo.png），并会覆盖主题提供的同名资源。

创建首个页面

创建 pages/index.mdx：

---
title: 首页
---

# 欢迎

这是我的个人站点。

文件路径将自动转换为路由：

pages/index.mdx       -> /
pages/guide.mdx       -> /guide
pages/blog/post.mdx   -> /blog/post