之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协作工具 docsify:一个神奇的文档站点生成器,简单轻巧,无需静态构建html 教程版: http://me.52fhy.com/learn-markdown-generate-tool/#/ loppo 官网: https://github.com/ruanyf/loppo 依赖 node.js

概述 知识与思路 代码实现 概述 Markdown 很适合于技术写作,因为技术写作并不需要花哨的排版和内容, 只要内容生动而严谨,文笔朴实而优美. 为了编写对读者更友好的文章,有必要生成文章的标题导航,让读者有个预期的阅读概览.当文章标题比较多时,手工去编写导航锚点比较费时,因此决定使用Python解析Markdown文档自动生成标题导航. 知识与思路 写过Markdown的人知道,Markdown的标题是使用一到六个# 左右包围住标题文字,而锚点是 [标题](#标题). 比如 ## 知识与思路

设计初衷 节约时间 Java 文档一直是一个大问题. 很多项目不写文档,即使写文档,对于开发人员来说也是非常痛苦的. 不写文档的缺点自不用多少,手动写文档的缺点也显而易见: 非常浪费时间,而且会出错. 无法保证及时更新.代码已经变了,但是文档还要同步修改.需要强制人来维护这一种一致性.这很难. 为什么不是 swagger-ui java 的文档有几类: jdk 自带的 doc 生成.这个以前实践给别人用过,别人用 C#,看到 java 的默认文档感觉很痛苦. 就算是我们 java 开发者,也很讨

学习shell脚本编程的一次实践,通过shell脚本生成数据库的markdown文档,代码如下: HOST=xxxxxx PORT=xxxx USER="xxxxx" PASSWORD="xxxxxx" DATABASE_PREFIX="xxxxxx" QUERY_DATABASE="select distinct TABLE_SCHEMA from information_schema.TABLES where TABLE_TYPE=

Create React Doc 是一个使用 React 的 markdown 文档站点生成工具.就像 create-react-app 一样,开发者可以使用 Create React Doc 来开发.部署 markdown 站点或者博客而不用关心站点环境配置信息. 特性 零配置书写 markdown 文档站点. markdown 文档支持懒加载以及热加载. 基于文件目录自动生成多层级菜单. 支持一键发布到 GitHub Pages. 使用 create-react-doc 搭建的文档站点 bl

目录 1.SwaggerDoc引用 主要接口 接口实现 2.Startup配置 注册SwaggerDoc服务 注册Swagger服务 引用Swagger中间件 3.生成MarkDown 4.生成示例 5.MarkDown转PDF 完整项目示例 基于 Swashbuckle.AspNetCore ,根据SwaggerGenerators生成的文档生成 MarkDown 文档. 文档功能: [x] JSON 数据格式展示 Request .Response 数据结构(支持实体多级引用) [x] 生成

前言 之前我写了一篇关于C#处理Markdown文档的文章:C#解析Markdown文档,实现替换图片链接操作 算是第一次尝试使用C#处理Markdown文档,然后最近又把博客网站的前台改了一下,目前文章渲染使用Editor.md组件在前端渲染,但这个插件生成的目录树很丑,我魔改了一下换成bootstrap5-treeview组件,好看多了.详见这篇文章:魔改editormd组件,优化ToC渲染效果 此前我一直想用后端来渲染markdown文章而不得,经过这个操作,思路就打开了,也就有了本文的C

微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制,目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面.你还可以自己定制模版,具体参考 how to create custom template. 源代码

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景 没有背景.就自己做自己的背景 在当今各种盛行的前后端分离.restful service开发过程中,接口文档是必不可少的.对于前后端分离的开发中,后端开发需要将接口写好后需要告诉前端工程师接口的请求参数.响应示例等重要信息,而对于对外暴露的restful接口服务,我们提供接口也是需要具备相同的接口文档的. 但是对于后端工

Markdown 和 MkDocs 简介 Markdown 的语法简洁明了.学习容易,而且功能比纯文本更强,因此有很多人用它写博客.世界上最流行的博客平台 WordPress 和大型 CMS 如 Joomla .Drupal 都能很好的支持 Markdown . MkDocs 是一个用于创建项目文档的快速,简单的静态站点生成器.文档源码使用 Markdown 来撰写,用一个 YAML 文件作为配置文档. MkDocs 处理的是一系列的 Markdown 文档,然后将 Markdown 文档的内容

作者:zyl910 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具.对于Objective-C来说,目前最好用的工具是appledoc和doxygen.可是这两种工具对于注释的要求略有区别.于是我经过一番摸索,找到了一套能同时兼容这两种工具的注释写法. 工具简介——appledoc:简单方便,适于生成apple风格的html文档,及直接集成到xcode帮助(docset).官网 http://gentlebytes.com/appledoc/ .doxygen:功能强大,适

首先安装vscode工具,具体的使用可以参考之前的博文:<Visual Studio Code教程:基础使用和自定义设置> VScode已经默认集成markdown文档编辑插件.可以新建一个.md文件Visual Studio Code 原生就支持高亮Markdown的语法,想要一边编辑一遍预览,有两种方法:1.Ctrl + Shift + P 调出主命令框,输入 Markdown,应该会匹配到几项 Markdown相关命令 2.先按Ctrl + K,然后放掉,紧接着再按 v,也能调出实时预览

叮叮叮....一阵铃声响起,大家都陆续来到了课堂,看老师没来,小张和小胖又闲聊起来,小张问:怎么样,smart-doc好用吧.小胖笑着说:挺好用的,不过? 小张看卖关子,问到:不过什么,有什么新发现?小胖说:我在试用了这个之后,发现还能进一步简化,大家在用这个的时候,更多的是关心能不能快速帮我生成文档,没人想写那一套模版代码.小张说:你说的也有道理,那你有什么好办法.小胖说:可以借助maven自定义插件,把生成文档的模版代码全部隐藏起来,让大家只需要引入这个插件,需要生成文档的时候,点一下按钮就

首先安装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

喜欢用 Markdown 写文档,那怎么把一个个 Markdown 文档组成在一起呢? 这篇文章,分享了一个用 GitBook 来组织 Markdown 文档的办法.一起了解下吧. Markdown 是一种轻量级标记语言.只需人们纯文本编写文档,加上点标记符号,就能转成有格式的文档(如 HTML 富文本).已广泛应用在笔记.文档.博客.出书等.2016 年 RFC 7763 开始也引入了 MIME 类型 text/markdown . 1 准备工具 安装 Node.js: https://nod

layout: postcategory: javatitle: 入坑 docsify,一款神奇的文档生成利器!tagline: by 沉默王二tags: - java Guide 哥是我认识的一个非常优秀的年轻人,胖嘟嘟的身躯里充斥着无穷无尽的才华,他的 JavaGuide 在 GitHub 上已经标星 91K+ 了,空闲的时候我都会上去瞅两眼,毕竟学习使我快乐,嘿嘿. 有一天,我发现,他整的那个在线版看起来非常漂亮,我就问他用什么做的,他就会回我说,"docsify,很方便."刚好

我用 python 写了一个自动生成索引的脚本 简介:为了刷算法题,建了一个 GitHub仓库:PiperLiu / ACMOI_Journey,记录自己的刷题轨迹,并总结一下方法.心得.想到一个需求:能不能在我每新增一条题目的笔记后,利用程序自动地将其归类.创建索引?用 Python 实现一个入门级的小脚本,涉及到文件读写.命令行参数.数组操作应用等知识点,在此分享给朋友们. 需求实现 我有一个 Markdown 文档,长成下面这个样子: # ACM/OI Journey在此留下刷题痕迹与刷题

前言 最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的 能够实时生成在线文档 支持全文搜索 支持在线调试功能 界面优美 说实话,这个需求看起来简单,但是实际上一点的都不简单. 我花了几天时间到处百度,谷歌,技术博客 和 论坛查资料,先后调研了如下文档生成工具: gitbook github地址:https://github.com/GitbookIO/gitbook 开源协议:Apache-2.0 License Star: 22.9k 开

写在开头,之前我是使用Gitee与Github作为图床和Picgo搭配Typora使用的 ,但因为最近觉得这样还是稍微比较繁琐,然后因为VS Code是我的主要文本编辑器.Cpp,Python等均是在VS Code上完成编写代码和运行的.所以我觉得Markdown文本其实也可以融入其中一起使用. (本文其实就是配置完VS Code以后写成的,感觉很棒) 安装的插件列表: Markdown All in One picgo Markdown Preview Github Styling 目前还有一

虽然有go语言的swagger,但是go版本的swagger对代码的侵入比较大,因此抽空实现了基于GO语言生成markdown文档的工具 开源链接地址: https://github.com/w3liu/gendoc gendoc 文档生成工具 MarkDown生成说明 示例 // doc是字段说明 // 如果是必填項,doc里填写 required 即可,注意required前面需要加空格 type ReqCreateOrder struct { Pass string `json:"pass