文档生成工具 idoc

ASCH 发布于2019-08-21 10:42 / 1355人阅读

摘要：文档生成工具简介通过生成静态页面的工具。通过生成静态页面的工具本地存储操作本地操作浏览器各种方法通知常用命令测试工具快捷键源码仓库仓库地址欢迎提需求和，提交地址。运行预览生成的静态页面。监控文件发生变化自动。

AIP文档生成工具

    ,,        ,,
    db      `7MM
              MM
  `7MM   ,M""bMM  ,pW"Wq.   ,p6"bo
    MM ,AP    MM 6W"   `Wb 6M"  OO
    MM 8MI    MM 8M     M8 8M
    MM `Mb    MM YA.   ,A9 YM.    ,
  .JMML.`Wbmd"MML.`Ybmd9"   YMbmd"

简介

通过markdown生成静态页面的工具。经常用 markdown 写一些接口文档，为了方便特写此工具玩耍。生成的页面预览效果

这些文档是都是使用idoc生成的页面哦，可以提交用idoc生成的文档哦提交收录。

JSLite.io - 这个是现代浏览器类似jQuery的库，体积小。

idoc - 通过markdown生成静态页面的工具

store.js - js本地存储操作

cookie.js - js本地cookie操作

iNotify - 浏览器各种方法通知

Backbone.js

Lua5.3

git

gulp-book

shell常用命令

测试工具

chai

mocha

should

快捷键

Sketch

bash

sublime

源码仓库

仓库地址【https://github.com/jaywcjlove/idoc】欢迎提需求和bug，提交地址
issues 。

全局安装

$ npm install idoc -g

使用方法

任意目录下新建test文件夹，并进入test文件夹如：mkdir test && cd test。

在你在的目录下面建立 md 文件夹专门放你的所有 md 文件。

导航菜单是根据 md 里面的文件目录结构生成导航菜单。

在 test 文件夹根目录初始化运行 idoc init 命令，自动生成 package.json 文件。

生成静态页面，运行 idoc build 命令。

运行 idoc server 预览生成的静态页面。默认预览地址为 http://localhost:1987/。

这个时候你可以将生成的文件上传至 github 的 gh-pages 分支中，外网预览。

命令文档

命令使用帮助。

Usage: idoc [options]

Options:

  -h, --help           output usage information
  -V, --version        output the version number
  -C, --Create   Select Directory Makefile.
  init                 init a documentation.
  build                Markdown produces static pages document.
  watch                Listener "md" file is automatically generated pages.
  server               Open local static html server.
  clean                Clear the generate static files.

Examples:

  $ idoc init
  $ idoc init [path]
  $ idoc init [path] -C ~/idoc/
  $ idoc watch
  $ idoc server
  $ idoc clean

init

初始化文档文件

# 默认生成模板和配置文件，将当前文件夹根目录的所有md文件参数生成到配置文件package.json中
$ idoc init
# 将指定的 md 文件拷贝到当前目录下，生成模板和配置文件
$ idoc init ~/md/JSLite.md
# 将指定的两个 md 文件拷贝到当前目录下
$ idoc init ~/git/_idc/package.md  ~/git/_idc/dir/directory.md
# 将指定的 _idc 目录下的所有 md 文件拷贝到当前目录下
$ idoc init ~/git/_idc/

# 指定生成模板和配置文件
# 将“JSLite.md hotkeys.md”两个 md 文件拷贝到指定目录 `~/idoc/` 下面
# 生成模板需要的文件
# 第一个 md 文件是首页
$ idoc init JSLite.md hotkeys.md -C ~/idoc/

build

生成静态 HTML 页面到指定目录中。

$ idoc build

watch

监控 md 文件发生变化自动 build。

$ idoc watch

server

打开本地静态 html 服务器，预览你生成的页面。

$ idoc server

clean

清除生成的静态文件。

$ idoc clean

提交收录

在 issues 中提交你的连接，我讲收录在此。格式如下：

# 我的 xxx 使用 idoc 生成文档
[文档名称](连接地址)

TODO

[x] idoc 基本命令定义

[x] 添加 build 命令，markdown生成静态页面

[x] 添加 watch 命令，监控markdown文件自动生成HMTL页面

[x] 默认模板制作

[x] 树形菜单生成

[x] 添加 server 命令，预览生成的静态页面

[x] 添加多页面导航菜单

[x] 添加 clean 命令

[x] 静态资源相对路径引用

[ ] 判断是否存在markdown树形导航菜单

[ ] 第二个模板制作

[ ] 模板切换命令

[ ] api 检索功能

[x] 兼容windows路径(cmd工具冒得问题嘞)

关注公众号

GPU云服务器云服务器接口文档生成工具文档生成 python生成文档 python文档生成

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/86030.html

优于 swagger 的 java markdown 文档自动生成框架-01-入门使用

摘要：很多项目不写文档，即使写文档，对于开发人员来说也是非常痛苦的。无法保证及时更新。是基于注解的文档生成工具。让文档的阅读者享受到等同于手写文档的体验。将信息的获取和生成区分开。基于原生的注释，尽可能的生成简介的文档。设计初衷节约时间 Java 文档一直是一个大问题。很多项目不写文档，即使写文档，对于开发人员来说也是非常痛苦的。不写文档的缺点自不用多少，手动写文档的缺点也显而易见：...

RdouTyping 2019-08-16 15:53 评论0 收藏0
javascript之iframe

摘要：可取得子窗口的对象。获取页面高度父子页面互访子访问父等到的信息父访问子等到的信息 iframe可以做的事情：实现跨域解决IE6下select遮挡不住的问题解决ajax的前进后退问题实现异步上传 iframe基本知识 iframe元素会创建包含另外一个文档的内联框架操作iframe 1）隐藏iframe表框设置frameborder为0； ...

Enlightenment 2019-08-22 12:45 评论0 收藏0
iframe,我们来谈一谈

摘要：通常我们可以在后配置各种指定资源路径，有如果你未指定的话，则是使用规定的加载策略默认配置就是同域这里和有一点瓜葛的就是和就是用来指定的有效加载路径。某大咖说: iframe是能耗最高的一个元素，请尽量减少使用某大牛说: iframe安全性太差，请尽量减少使用...wtf, 你们知不知道你们这样浇灭了多少孩纸学习iframe的热情和决心。虽然，你们这样说的我竟无法反驳，但是ifram...

awesome23 2019-08-21 13:29 评论0 收藏0
ssr无需等待，让前端独立于后端进行开发

摘要：大家肯定遇到过，当后端没有编写完成时，前端无法进行调试，这就导致了前端会被后端阻塞的情况。强制跨域访问请求不报错启动多个服务，自动解决端口冲突设置指定端口号全局安装命令帮助。 ssr showImg(https://segmentfault.com/img/bVyhY9); 将一个目录设置成一个静态服务器。。大家肯定遇到过，当后端 API 没有编写完成时，前端无法进行调试，这就导致了前...

Java_oldboy 2019-08-22 10:58 评论0 收藏0