V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
muyunyun
V2EX  ›  分享创造

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

  •  
  •   muyunyun ·
    MuYunyun · 2021-06-17 10:36:52 +08:00 · 2149 次点击
    这是一个创建于 1280 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    特性

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

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

    第 1 条附言  ·  2021-10-15 19:39:04 +08:00

    1.5.0

    Feature

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

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

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

    文档说明

    12 条回复    2021-06-24 07:47:27 +08:00
    zingwu
        1
    zingwu  
       2021-06-17 11:35:26 +08:00
    支持一下,已 star
    haowen737
        2
    haowen737  
       2021-06-17 11:56:10 +08:00
    Cool,已 star
    beizhedenglong
        3
    beizhedenglong  
       2021-06-17 14:20:30 +08:00
    老哥在 pdd 怎么做到每天玩 github 的,有点强
    dianso
        4
    dianso  
       2021-06-17 17:06:59 +08:00 via Android
    我打算用 py 写个,没想到正好遇到这个了。
    muyunyun
        5
    muyunyun  
    OP
       2021-06-17 18:41:09 +08:00
    @haowen737 厉害啦文兄
    muyunyun
        6
    muyunyun  
    OP
       2021-06-17 18:41:29 +08:00
    @zingwu 感谢支持
    muyunyun
        7
    muyunyun  
    OP
       2021-06-17 18:41:51 +08:00
    @dianso 欢迎试用反馈
    muyunyun
        8
    muyunyun  
    OP
       2021-06-17 18:42:25 +08:00
    @beizhedenglong 哈哈, 时间挤挤还是有的
    beizhedenglong
        9
    beizhedenglong  
       2021-06-17 19:12:17 +08:00
    @muyunyun 我咋说看你头像这么眼熟,你好像用过我的 leetcode 生成工具
    muyunyun
        10
    muyunyun  
    OP
       2021-06-18 09:42:43 +08:00
    @beizhedenglong 学习啦, 抱拳
    thetbw
        11
    thetbw  
       2021-06-19 14:45:47 +08:00
    404 了
    muyunyun
        12
    muyunyun  
    OP
       2021-06-24 07:47:27 +08:00
    @thetbw 更新了
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1045 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 19:34 · PVG 03:34 · LAX 11:34 · JFK 14:34
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.