Flatdoc

程序文档生成工具
授权协议 MIT
开发语言 JavaScript HTML/CSS
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 不详
投 递 者 田玉韵
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

Flatdoc 是一个小型的 JavaScript 文件,可读取 Markdown 文件并渲染成页面,特别适合用来为开源项目生成文档。

特点:

  • 无需服务端组件支持
  • 无需构建过程
  • 可通过 Github Pages 发布
  • 可获取来自 Github 的 Readme 文件
  • 漂亮的默认风格
  • 只是创建 HTML 文件然后发布
  • 早先自己的 Github Pages 是 Jekyll 配置的,更新起来麻烦,年龄大了,精力有限,不打算自己维护这些东西了,要是真写点啥也不这么折腾了,随便找个地方就发布了。但是页面不想荒废了,留一个可以随时更新点啥信息的页面还是必须的。找来找去,发现 Flatdoc 比较方便,内容可以用 Markdown 写,页面直接在浏览器端渲染,符合我的需求。 Flatdoc 在其项目主页上写的比较明确:

 相关资料
  • 实体可以用来作这件事情 有两个文件一个是主文件docbook.xml,包含文件头和文档信息;另一个文件file.xml是文档内容,主文件如下: <?xml version='1.0' encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5/zh_cn" "http://www.oasis-open.org/

  • 本文向大家介绍Python文档生成工具pydoc使用介绍,包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项,需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc. pydoc是Python自带的模块,

  • https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统,参考

  • easyopen提供一个简单的api文档查看页面,类似于swagger,基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明,也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示: 左边的树形菜单对应文档名称,点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的,需要

  • CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

  • 支持在项目中使用 Swagger 注解语法,运行命令,生成 Swagger 文件。 Swagger 是最流行的 API 开发工具,它遵循 OpenAPI Specification(OpenAPI 规范,也简称 OAS)。 Swagger 可以贯穿于整个 API 生态,如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的,和编程语言无关的 API 描述规范。 imi-