基本简介

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

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

  1. 静态文档,动态文档和活动文档

    静态文档 动态文档 活动文档 三者的区别 万维网的文档可以分为3类:静态文档.动态文档和活动文档. 静态文档 静态文档是指内容固定的文档,它是由万维网服务器创建,并存放在其中. 当客户利用 浏览器访问 ...

  2. java+swagger+侵入,一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案

    一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案 一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案 作者:互联网活化石 来源:http://suo.im/5Si ...

  3. delphi ui编辑工具源码_一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案

    在后端项目中,难免遇到需要写接口文档方便第三方调用的场景,一般业界最常用的方案是使用swagger.Java项目中,一般采用springfox项目,它集成了swagger和swagger-ui,不需要 ...

  4. OkHttpUtils-2.0.0 升级后改名 OkGo,全新完美支持 RxJava,比 Retrofit 更简单易用。

    okhttp-OkGo 项目地址:jeasonlzy/okhttp-OkGo 简介:OkHttpUtils-2.0.0 升级后改名 OkGo,全新完美支持 RxJava,比 Retrofit 更简单易 ...

  5. adoc(asciidoc)文档编辑利器-强于Markdown

    adoc 文档编辑利器 asciiddoc功能比较强大,比markdown给为强大,但是也复杂一下,使用门槛稍高,但不过还好.查查手册经常谢谢,很容易掌握的. 介绍 markdown 大家基本都熟悉, ...

  6. bat 删除文件_利用电脑文本文档建立一个简单方便的删除文件的小程序

    删除文不需要的文件或者资料,是日常工作中必定会遇到了. 各种的杀毒软件或者防护软件都具备删除文件的功能,例如360.腾讯电脑管家.这些操作起来其实也不是太麻烦! 不过呢!今天来和大家分享一个更简单的方 ...

  7. 百度文档搜索与Google文档搜索的简单比较

    很多有具有参考价值的资料,比如学生写论文报告,老师做课件,找工作准备简历都需要参考其他人的成果.在互联网上,这类资料一般不是普通的html网页,而是以Word.ppt(s).Excel.pdf等格式存 ...

  8. 别再搞纯文本了!多模文档理解更被时代需要!

    文 | Ryan 都已经2021年了,互联网已经今非昔比,20年前纯文本的日子已经一去不复返,文字已经满足不了网页.文章的需求,绝大部分都会有着精心设计的表格.图片,甚至视频.PDF文档这种富文本格式 ...

  9. EZDML新版支持生成导出Markdown格式文本文档

    生成内容包括:模型图.字典.示例列表.表单.JSON.列表查询接口.增删改查接口等.可直接在表属性页生成预览,也可以选择多个表导出md文件(不选默认全部): 生成脚本采用了较慢的js脚本.以往我都会默 ...

最新文章

  1. 第六课.NLP文本分类任务
  2. 并查集 HDOJ 5441 Travel
  3. 璧山哪里可以学基础计算机,璧山学电脑在哪里
  4. 教你认识H3C的设备
  5. http --- 缓存
  6. python中range 函数_pythonrange,range函数的用法
  7. Enterprise Library—缓存应用程序块
  8. Apache 分割日志
  9. tensorflow实现LeNet-5模型
  10. Git 分支及bug分支合并
  11. SSM框架面试题整理
  12. matlab数学建模试卷,matlab数学建模习题
  13. 大陆港澳台身份证正则验证
  14. BIOS实战之HW monitor
  15. bzoj4816[SDOI2017]数字表格
  16. linux C -- ftok函数
  17. 什么是软件测试?这份工作到底怎么样?
  18. Pod挂载Volume失败问题分析
  19. Ubuntu重启后如何配置网络
  20. 深度学习模型,为诊断糖尿病视网膜病变带来福音

热门文章

  1. 计算机网络——知识点
  2. win10安装提示“我们无法创建新的分区”
  3. 虾皮春节期间的发货问题和物流设置
  4. Matlab:创建字符串数组
  5. JavaScript中字符串数组赋值失败,不是每个字符串,却是字符。
  6. 【Apollo配置中心】Apollo环境配置
  7. 华为虚拟服务器密码忘记怎么办,手机云服务器密码忘记了
  8. 做外贸,用自己公司申请外汇账户收款好,还是用离岸公司收款好一些?
  9. 安全合规/GDPR--27--我们通过了GDPR合规认证
  10. CCSV5菜单栏中没有Tools按钮,如何显示出来?