This is early WIP!
页面与路由

页面与路由

Pressify 使用文件系统路由,即页面的文件路径会被简单地映射为路由路径,这会使整个项目的路由变得非常直观。

Pressify 的默认路由规则是,收集 docs 目录下的以 .md.mdx.js.jsx.ts.tsx 结尾的文件作为页面。

假设你的文档目录结构如下:

└─ docs
   ├─ guide
   │  ├─ getting-started.md
   │  └─ index.md
   ├─ contributing.md
   └─ README.md
└─ docs
   ├─ guide
   │  ├─ getting-started.md
   │  └─ index.md
   ├─ contributing.md
   └─ README.md

实际得到的路由映射规则是:

文件路径路由路径
/README.md/
/contributing.md/contributing
/guide/index.md/guide
/guide/getting-started.md/guide/getting-started
TIP
  • 不管是 .md 还是 .mdx,Pressify 都会统一使用 MDX 来解析 Markdown 文件内容。
  • 如果是 .js.jsx.ts.tsx 页面文件,这些文件模块需要默认导出一个组件。

首页

Pressify 默认主题提供了首页的布局,也就是这个页所展示的样子。 如果在 Markdown 的 frontmatter 中指定了 layout: home,则该页面就会被当做首页:

---
layout: home
---
---
layout: home
---

与首页布局相配的还有好些 frontmatter 配置项:

---
layout: home

# 页面展示的大标题,通常是你的包名/产品名
heroText: Pressify

# 用于介绍产品的简短描述
tagline: Vite & React 驱动的静态网站生成器

# 操作按钮
actions:
  - text: 快速上手
    link: /zh/guide/getting-started
  - text: 项目介绍
    link: /zh/guide

# 产品特性列表
features:
  - title: ⚡️ Vite 驱动
    details: Vite 是基于 ES Module 的前端开发构建工具,以快著称。
  - title: 📘 MDX
    details: 可以直接在文档中写 JSX,甚至导入 React 组件。
  - title: ✨ Tailwind CSS
    details: 可以在文档中使用 Tailwind CSS 提供的工具类对样式进行调整。
  - title: 内置 unplugin-icons
    details: 可以非常简单地在文档中按需使用海量的图标。
  - title: 主题
    details: Pressify 本身并不渲染内容,需要借助主题来执行渲染
  - title: 还有...

# 底部 footer 文案
footer: Copyright © 2022-present Codpoe. Built with Vite & React.
---
---
layout: home

# 页面展示的大标题,通常是你的包名/产品名
heroText: Pressify

# 用于介绍产品的简短描述
tagline: Vite & React 驱动的静态网站生成器

# 操作按钮
actions:
  - text: 快速上手
    link: /zh/guide/getting-started
  - text: 项目介绍
    link: /zh/guide

# 产品特性列表
features:
  - title: ⚡️ Vite 驱动
    details: Vite 是基于 ES Module 的前端开发构建工具,以快著称。
  - title: 📘 MDX
    details: 可以直接在文档中写 JSX,甚至导入 React 组件。
  - title: ✨ Tailwind CSS
    details: 可以在文档中使用 Tailwind CSS 提供的工具类对样式进行调整。
  - title: 内置 unplugin-icons
    details: 可以非常简单地在文档中按需使用海量的图标。
  - title: 主题
    details: Pressify 本身并不渲染内容,需要借助主题来执行渲染
  - title: 还有...

# 底部 footer 文案
footer: Copyright © 2022-present Codpoe. Built with Vite & React.
---