易文档(yidocs),更简单的 markdown 静态文档生成模板

2022-09-16 05:19:23 +08:00
 chensuiyi

基本简介

yidocs (易文档),是在 vuepress 主题 vuepress-theme-hope 基础上,进一步简化使用的文档模板。

大部分配置和参数都有默认值,使用 yidocs (易文档)的用户,只需要填写必要的名称、描述、作者等即可。

展示效果如下:

开源地址

https://gitee.com/yicode-team/yidocs

文档地址

https://yicode.tech

为什么创建易文档( yidocs )

  1. vuepress-theme-hope 和 vuepress 仍然有大量配置,希望更简便一点
  2. 左侧菜单和顶部导航,需要手动配置,易文档只需要编写文档,其他的自动处理
  3. 相关样式、布局、图标和项目整体风格固定,避免过多精力花在文档细节调整上

安装使用

[易文档] 安装步骤

访问易文档( yidocs )仓库地址

易文档仓库地址 https://gitee.com/yicode-team/yidocs

克隆仓库或直接下载 zip 文件

  1. 方式 1 ,使用对应的地址克隆仓库到本地
  2. 方式 2 ,直接下载 zip 文件,解压到本地

安装相关依赖

npm install

本地运行项目

npm run dev
1209 次点击
所在节点    分享创造
0 条回复

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/880416

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX