Docusaurus文档

docs-site-template — Docusaurus 文档模板

作者 sovrium

基于 Sovrium 配置即代码引擎的文档站模板，把 content/docs/ 下的 Markdown 文件生成带分组侧边栏、上下页导航、目录和 Shiki 代码块的文档站点。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

2 个预览视图

桌面端首页1 / 2

访问演示网站在新标签页打开

桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-01查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

Markdown 文件即路由：content/docs/ 下每个文件生成一个页面

自动生成分组侧边栏、上一页/下一页导航与目录（TOC）

使用 Shiki 进行代码块高亮

站点完全由 app.yaml 和 config/ 声明，无需应用代码

本地启动零配置：内嵌 SQLite 与本地文件存储，无需环境变量

提供 Scalingo 一键部署按钮，自动生成密钥并附带 PostgreSQL 附加组件

模板详细介绍

这是一个文档站点模板，定位为 Docusaurus 的替代方案。它不依赖传统的前端应用代码，而是通过 app.yaml 与 config/ 目录下的配置声明整个站点，由 Sovrium 引擎解释配置后生成自托管的 Web 应用。内容层面，content/docs/ 下的每个 Markdown 文件对应一个路由，并自动获得分组侧边栏、上一页/下一页导航、目录（TOC）以及 Shiki 代码高亮。

使用方式上，可以在 GitHub 上点击 Use this template 复制仓库，也可以用 sovrium init my-docs-site --template docs-site 在本地初始化。本地运行只需 sovrium start app.yaml，默认使用内嵌 SQLite 与本地文件存储，启动不要求配置环境变量；.env.example 中列出了可选的数据库、认证引导、邮件和 AI 相关变量。

部署方面，README 提供了 Scalingo 的一键部署按钮，会附带 PostgreSQL 附加组件，因为 Scalingo 文件系统是临时的，数据库用于跨部署保留数据，文件上传也存入 Postgres；密钥自动生成，只需填写 BASE_URL。其他主机同样可以运行 sovrium 二进制并加载该配置。该仓库由 Sovrium 主仓库在每次发布时自动发布，问题可在此提交，代码贡献需回到上游主仓库；引擎版本固定在 .sovrium-version 中。

Docusaurus文档

适合你的项目吗？

适用场景

为开源项目或产品搭建自托管的 Markdown 文档站点
在本地快速预览和迭代文档内容与侧边栏结构
通过 Scalingo 或其他主机部署带数据库的文档站点
作为 Docusaurus 之外的文档站方案进行对比与选型

适合人群

希望用 Markdown 维护文档、不想编写前端应用代码的团队
需要自托管文档站点并接受 Sovrium 配置方式的用户
愿意通过修改 app.yaml 与 config/ 来调整站点行为的开发者

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

1
在 GitHub 上点击 Use this template 复制仓库，或运行 sovrium init my-docs-site --template docs-site 本地初始化
2
本地运行使用 sovrium start app.yaml，默认内嵌 SQLite 与本地文件存储，无需环境变量
3
可选配置见 .env.example，涵盖数据库、认证引导、邮件和 AI 相关变量
4
部署到 Scalingo 时使用 README 中的按钮，会附带 PostgreSQL 附加组件，需填写 BASE_URL
5
引擎版本固定在 .sovrium-version；代码贡献需提交到 Sovrium 上游主仓库

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

允许免费使用、修改、商用和分发该版本代码。
分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

模板代码采用 MIT 许可，但运行所需的 Sovrium 引擎单独授权（BSL 1.1），并非 MIT；使用该模板实际依赖并受引擎自身许可条款约束。
该仓库由 Sovrium 主仓库自动发布，代码贡献需提交到上游主仓库，本地修改可能在下一次发布时被覆盖。
代码贡献需提交至上游 monorepo，而非本仓库。
模板绑定特定引擎版本（记录于 .sovrium-version），需使用对应版本的 Sovrium 引擎运行。
部署到 Scalingo 时文件系统为临时性，数据依赖 PostgreSQL 附加组件持久化，文件上传也存入 Postgres，需额外配置数据库。
演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
域名、托管、数据库、支付或 AI 等外部服务可能另外收费。

查看原文依据

Permission is hereby granted, free of charge
许可证原文

The Sovrium engine itself is licensed separately ([BSL 1.1](https://github.com/sovrium/sovrium/blob/main/LICENSE.md)).
README 原文

This repository is **auto-published from the [Sovrium monorepo](https://github.com/sovrium/sovrium)** on every release
README 原文

please send code contributions upstream to the monorepo so the template stays in sync with the engine.
README 原文

The pinned engine release lives in `.sovrium-version`.
README 原文

Scalingo's filesystem is ephemeral — the database keeps your data across deploys; file uploads are stored in Postgres too
README 原文

https://github.com/sovrium/docs-site-template/blob/main/LICENSE https://github.com/sovrium/docs-site-template/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-01。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台: GitHub
资料与维护参考分: 资料较完整 · 80 / 100
技术栈: Docusaurus
网站类型: 文档

这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间: 2026-09-27
截图检查日期: 2026-10-01

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Docusaurus。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

已完成服务器许可规则与 AI 来源核对；未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: 81e6992082fe5adf03e20f2ce5c14030d0633e8d9d21f14bf78ef2ca3dd5ada5

2026-10-01T03:43:04.107Z

来源文件 / 仓库

# Sovrium Docs Site

> A docs website from markdown — a Docusaurus alternative.

Built with [Sovrium](https://sovrium.com) — a configuration-as-code interpreter: one config
file in, a complete self-hosted web application out.

[![Deploy on Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://dashboard.scalingo.com/create/app?source=https://github.com/sovrium/docs-site-template)

## Use this template

Click **Use this template** on GitHub to copy this app into your own repository (clean
history, yours to modify), or scaffold it locally:

```bash
curl -fsSL https://sovrium.com/install | sh
sovrium init my-docs-site --template docs-site
```

## What's inside

Markdown files under `content/docs/` become one route per file with a grouped sidebar, prev/next, a TOC, and Shiki code blocks.

Everything is declared in [`app.yaml`](./app.yaml) and the [`config/`](./config) tree —
no application code. Edit the config, restart, done.

## Run locally

```bash
sovrium start app.yaml
```

Zero-config: embedded SQLite, local file storage, no env vars required to boot. See
[`.env.example`](./.env.example) for the optional variables (database, auth bootstrap,
email, AI).

## Deploy

The **Deploy on Scalingo** button above provisions the app with a PostgreSQL addon
(Scalingo's filesystem is ephemeral — the database keeps your data across deploys; file
uploads are stored in Postgres too). Secrets are generated automatically; you only fill in
`BASE_URL`. Any other host works the same way: run the `sovrium` binary with this config
(see the [deployment guides](https://sovrium.com/en/docs/installation)).

## About this repository

This repository is **auto-published from the
[Sovrium monorepo](https://github.com/sovrium/sovrium)** on every release
(source: [`templates/docs-site`](https://github.com/sovrium/sovrium/tree/main/templates/docs-site)).
Issues are welcome here; please send code contributions upstream to the monorepo so the
template stays in sync with the engine. The pinned engine release lives in
`.sovrium-version`.

License: [MIT](./LICENSE). The Sovrium engine itself is licensed separately
([BSL 1.1](https://github.com/sovrium/sovrium/blob/main/LICENSE.md)).

反馈内容错误