特点 支持热更新 快速启动,依赖于 vite,无需另起服务 自动生成组件导航 ui 采用了vant-ui的样式 核心方法覆盖率达到了 92.86% 使用 yarn add vite-plugin-vue-docs -D // vite.config.js import { defineConfig } from "vite"; import vue from "@vitejs/plugin-vue"; import vueDocs from "vite-p

一.现状 Vue框架在前端开发中应用广泛,当一个多人开发的Vue项目经过长期维护之后往往会沉淀出很多的公共组件,这个时候经常会出现一个人 开发了一个组件而其他维护者或新接手的人却不知道这个组件是做什么的.该怎么用,还必须得再去翻看源码,或者压根就没注意到这个组件 的存在导致重复开发.这个时候就非常需要维护对应的组件文档来保障不同开发者之间良好的协作关系了. 但是传统的手动维护文档又会带来新问题: 效率低,写文档是个费时费力的体力活,好不容易抽时间把组件开发完了回头还要写文档,想想都头大. 易出错

前言 最近做的项目使用了微前端框架single-spa. 对于这类微前端框架而言,通常有个utility应用,也就是公共应用,里面是各个子应用之间可以共用的一些公共组件或者方法. 对于一个团队而言,项目中公共组件和方法的使用难点不在于封装不在于技术,很多时候在于团队内部成员是否都能了解这些组件,以避免重复开发,从而提升团队效率. 如果是团队比较小,人员比较稳定的项目组可能还好点,对于团队比较大,人员流动较快的团队,这些通用组件和方法往往就被人遗忘在角落,很难再得到有效利用. 因为我所在的项目还在

如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的好处是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构可以提供追溯其他工作产品的上下文. 有文档的架构可以传达可供选择的架构解决方案. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构可以提醒架构师在其所作的某些决定背后的

假设你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",增加这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的优点是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构能够提供追溯其它工作产品的上下文. 有文档的架构能够传达可供选择的架构解决方式. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构能够提醒架构师在其所作的某些决定背后的

作为一个vim使用者,编写markdown文档时若不能用vim这怎么能受的了! 下面是我编写markdown的时候用到的插件 Plugin 'Markdown'Plugin 'Markdown-syntax' Plugin 'SirVer/ultisnips' 这三个插件的安装与介绍我就不累述了,网上一大堆. ps.第三个插件的安装使用可参考我之前的文章 下面我介绍一下怎么利用补全插件,修改snippets,方便我们编写markdown文档. 首先,网上存在这样的一篇文章 http://www.

最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出

Docz 用 MDX 写 React UI 组件文档 前言 为了提升开发效率,创建一套 UI 组件库是一种较为有效的方式之一:可以减少重复工作.提高可复用,所以现在越来越多团队开始创建自己的 UI 组件库.较早的 Twitter 的 Bootstrap 虽然只能称为 UI 库,但也大大提升了开发效率.后面 MVVM 大行其道 ,前端终于可以把 HTML.CSS.JS 放在一起开发包含 UI .交互真正意义上的组件了,现在有基于 React 的 Material-UI.国内阿里金服基于 React

使用 Laravel-Swagger 编写接口文档 Table of Contents Swagger 文档管理 官方网站:https://swagger.io/ 快速编写你的 RESTFUL API 接口文档工具,通过注释定义接口和模型,可以和代码文件放置一起,也可以单独文件存放. 优势 通过代码注解定义文档,更容易保持代码文档的一致性 模型复用,减少文档冗余,带来更可靠的文档 提供客户端访问接口,可以直接调试接口,不需要第三方工具进行调用测试接口 支持权限认证,等功能 Laravel Swa

1. 为什么抛弃MarkdownPad 2 ? MarkdownPad坊间号称 Windows 环境下最好用的markdown编辑器-EXO me??? 博主入MarkdownPad 2 坑就是因为这个坊间口碑,但是使用起来并不舒心-原因如下: 笨重,每次打开md文档都需要等待软件启动 无法预览效果,需要安装额外的软件Awesomium 打开文档,预览显示一片空白也是常事 2. Notepad++ 免费 轻量 插件众多 台湾同胞开发 支持众多语言风格的展示(可以集成编辑各类文档) 3. 搭建编写

程序员最讨厌的两件事情,第一种是写文档,另一种是别人没有写文档.有没有直接根据vue组件生成文档的呢?当然是有的的.但第三方使用起来不一定能和现有项目结合使用,往往需要额外的注释用来标记提取信息.使用第三方的一些比较常见问题 文档提取信息不全面,可能有些信息你需要提取但是它又不支持.这种情况下就只能修改三方的插件源码了. 需要额为的注释信息来标记,例如 vuese 需要给方法 打 @vuese.@arg 等标记来提供方法信息. 俗话说自己动手丰衣足食,打造自己的vue文档生成工具与自己项目结合使

作为一名优秀的Java开发工程师,编写接口文档向来是一件很头疼的事情.本来就被bug纠缠的很累了,你还让我干这? 其实,你可以试试ApiPost. ApiPost的定位是Postman+Swagger+Mock Server,主要用来发送调试接口和生成接口文档.如果你愿意,也可以用它生成Mock 数据,当Mock Server使用. 下面就简单介绍如何利用ApiPost调试接口和快速的生成接口文档,让您初步体验ApiPost的魅力! 1. API写完想要测试?试试模拟发送一次请求 新建接口,我想

背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如何使用 VS Code + Markdown 来编写 PDF 文档 效果演示 环境准备 [必须]安装 Visual Studio Code [必须]安装 Extension - Markdown PDF,主要用于生成 PDF [可选]安装 Extension - markdownlint,用于 ma

1.jupyter Notebook的组成 这里它的组件及其工程构成,帮助大家更好的用好jupyter Notebook 组件 Jupyter Notebook结合了三个组件: 笔记本Web应用程序:交互式Web应用程序,用于交互编写和运行代码以及编写笔记本文档. 内核:笔记本Web应用程序启动的独立进程,它以给定语言运行用户代码,并将输出返回给笔记本Web应用程序.内核还处理诸如交互式小部件,选项卡完成和内省的计算. 笔记本文档:自包含文档,其中包含笔记本Web应用程序中可见的所有内容的表示,

Spec Markdown 是一个基于markdown 的文档编写工具,安装简单,可以让我们编写出专业的文档 参考项目 https://github.com/rongfengliang/spec-md-demo 安装 全局 npm install -g spec-md 本地项目依赖 npm install --save-dev spec-md 项目使用 因为个人原因,比较喜欢使用yarn,所以项目基于yarn 初始化 初始化 yarn init -y 配置构建&&依赖 yarn add s

首先安装vscode工具,下载地址如下: https://code.visualstudio.com/ 在vs code的扩展中安装: Markdown Preview Enhanced 这款插件,安装完成重新加载即可生效 新建一个.md文件 Visual Studio Code 原生就支持高亮Markdown的语法,想要一边编辑一遍预览,有两种方法: 3.1. Ctrl + Shift + P 调出主命令框,输入 Markdown,应该会匹配到几项 Markdown相关命令 2.2. 先按Ct

一.什么是swagger 随着互联网技术的发展,前后端技术在各自的道路上越走越远,他们之间的唯一联系变成了api接口,api接口文档编程了前后端人员的纽带,而swagger就是书写api文档的一款框架. 官网: https://swagger.io/ 相关资源下载地址: https://download.csdn.net/download/zhixingwu/12008773 推荐: 也可以使用 showdoc来书写api文档. 官网: https://www.showdoc.cc/ 二.Swa

GitBook简介 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命令行工具(和Node.js库): GitBook 可以将您的内容作为网站(可定制和可扩展)或电子书(PDF,ePub或Mobi)输出: GitBook.com 是使用 GitBook 格式创建和托管图书的在线平台.它提供托管,协作功能和易于使用的编辑器. GitBook环境安装(需要安装NodeJS环境) NodeJS安装: 官方下载地址:https://nodejs.

开始之前 是不是在github上看项目的时候第一眼就要看项目介绍? 是不是经常在某些项目的代码里面看到一个README.MD文档 却不知道怎么写? 你是不是不知道,反正我是的. 作为一个程序员,可能写了几年之后都会或多或少的需要写一份可以帮助别人快速了解你的项目的文档,这个时候如果你用txt或者word来写 ,是不是有点不够逼格,又或排版略显麻烦? 那么它来了 -- MarkDown Markdown是一种轻量级的标记语言,使用极为简单的语法就可以实现 段落,文字字体,超链接,图片,代码块,表格

网址:http://apiary.io/ 介绍:一款非常强大的前后端交互api设计编辑工具(编辑器采用Markdown类似的描述标记,非常高效),高颜值的api文档,还能生成多种语言的测试代码. 中文教程参考: http://blog.csdn.net/pleasecallmewhy/article/details/29398559 案列: http://docs.gistfoxapi.apiary.io/#