Skip to content
eonseePublic

About

基于Nimbus的个人教程文档。SDoc 摒弃了繁琐的配置,致力于为开发者提供开箱即用的优雅体验。无论是构建个人知识库、开源项目说明,还是企业级帮助中心,SDoc 都能为你和你的读者提供如丝般顺滑的阅读体验。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SDoc 📝

一个轻量、极速、现代化的文档构建解决方案。

License: MIT PRs Welcome

SDoc 致力于为开发者提供极致的文档编写体验。摒弃冗余的配置,专注于内容本身。无论是个人知识库、开源项目文档,还是企业级帮助中心,SDoc 都能帮你优雅地完成。

✨ 核心特性

  • 🚀 极速响应:基于现代前端架构,毫秒级热更新,构建速度极快。
  • 📝 Markdown 优先:完美支持 GFM (GitHub Flavored Markdown) 与 MDX,支持在文档中直接嵌入交互组件。
  • 🎨 开箱即用的主题:内置精心设计的暗色/亮色主题,响应式布局,完美适配手机与 PC 端。
  • 🔍 本地全文检索:内置轻量级搜索引擎,无需依赖外部服务即可实现毫秒级内容检索。
  • 🧩 高扩展性:基于插件化架构,轻松接入第三方服务(如评论系统、数据统计等)。

🛠️ 快速开始

只需几分钟,即可在本地跑起你的文档站点:

  1. 克隆项目
    git clone https://github.com/eonsee/sdoc.git
    cd sdoc

About

基于Nimbus的个人教程文档。SDoc 摒弃了繁琐的配置,致力于为开发者提供开箱即用的优雅体验。无论是构建个人知识库、开源项目说明,还是企业级帮助中心,SDoc 都能为你和你的读者提供如丝般顺滑的阅读体验。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages