基于 React 开发了一个 markdown 文档站点生成工具, 欢迎提意见

爱意满满的作品展示区。

This topic created in 1816 days ago, the information mentioned may be changed or developed.

Create React Doc 是一个使用 React 的 markdown 文档站点生成工具。开发者可以使用其来开发、部署文档或者博客站点而无需关心额外的环境配置信息。

特性

建站理念: 文件即站点 (Files as a Site)。
开箱即用: 通过指定目录或文档, 一键生成文档、博客站点, 无需关心站点环境配置信息。
性能: 通过预渲染、懒加载大幅提升站点加载速度。
基于 mdx: 支持在 markdown 中书写 React 组件、数学公式等。
搜索引擎优化: 支持 SEO, 让文档更易被搜索。相关文档: SEO 在 SPA 站点中的实践
个性化: 支持自定义主题。
工作流: 集成 Github action, 支持自动化打包、发布站点。

使用其搭建的博客: http://muyunyun.cn/blog

Supplement 1 · Oct 15, 2021

1.5.0

Feature

🚀 支持 react-doc generate 命令，给 md 文件自动补全短链。issue、mr
🚀 支持展示短链以让文章链接持久化。issue、mr
🚀 支持在 Front-matter 区域中书写个别文件的变量。

在以下场景需求场合中，可以展示短链以优化 URL 的显示。

SEO 场景下需要链接持久化。
URL 链接中存在中文会被转码展示。
文档的路径与文件名经常变更。

文档说明

站点

React

文档

Markdown

12 replies • 2021-06-24 07:47:27 +08:00

zingwu

Jun 17, 2021

支持一下，已 star

haowen737

Jun 17, 2021

Cool，已 star

beizhedenglong

Jun 17, 2021

老哥在 pdd 怎么做到每天玩 github 的，有点强

dianso

Jun 17, 2021 via Android

我打算用 py 写个，没想到正好遇到这个了。

muyunyun

Jun 17, 2021

@haowen737 厉害啦文兄

muyunyun

Jun 17, 2021

@zingwu 感谢支持

muyunyun

Jun 17, 2021

@dianso 欢迎试用反馈

muyunyun

Jun 17, 2021

@beizhedenglong 哈哈, 时间挤挤还是有的

beizhedenglong

Jun 17, 2021

@muyunyun 我咋说看你头像这么眼熟，你好像用过我的 leetcode 生成工具

muyunyun

Jun 18, 2021

@beizhedenglong 学习啦, 抱拳

thetbw

Jun 19, 2021

404 了

muyunyun

Jun 24, 2021

@thetbw 更新了