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

create-react-doc 支持自定义博客、文档主题啦💐

  •  1
     
  •   muyunyun ·
    MuYunyun · 2021-02-03 04:18:47 +08:00 · 1724 次点击
    这是一个创建于 1149 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    特性

    • 建站理念: 文件即站点。
    • 开箱即用: 通过指定目录或文档, 一键生成文档、博客站点, 无需关心站点环境配置信息。
    • 性能: 文档支持懒加载提升站点加载速度。
    • 个性化: 支持自定义主题
    • 工作流: 集成 Github action, 支持自动化打包、发布站点。

    快速上手

    create-react-doc 非常容易上手。开发者不需要额外安装或配置 webpack 或者 Babel 等工具,它们被内置隐藏在脚手架中,因此开发者可以专心于文档的书写。

    如果你想在当前文件下建立站点文件 doc, 这里提供如下三种方式快速建站:

    npx

    npx create-react-doc doc
    

    npm

    npm init create-react-doc doc
    

    yarn

    yarn create react-doc doc
    

    如果想把模板内容内容拉取到当前文件夹, 则可以将如上命令的 doc 替换为 ., 比如执行 npx create-react-doc .

    主题

    create-react-doc 提供了官方默认主题 crd-seed。该主题支持以下特性:

    • 适配移动、PC 多端展示。
    • 支持暗黑模式。
    • 文档支持内嵌 codepen 、codesansbox 。
    • GitHub 联动。

    使用该主题搭建的站点有:

    如果您想定制化或者分享个人主题, 可以参考自定义主题章节。

    如果您有相关需求, 可以在该帖下或者项目 issue 中提出, 我尽量抽时间支持。

    开源不易, 求个 star, 万分感谢。项目地址

    1 条回复    2021-02-04 09:57:25 +08:00
    zingwu
        1
    zingwu  
       2021-02-04 09:57:25 +08:00
    挺好的,已 star
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1560 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 17:00 · PVG 01:00 · LAX 10:00 · JFK 13:00
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.