开发工具 这样的文档工具有人喜欢么?

i5ting · 2014年08月17日 · 最后由 chenzhong 回复于 2014年08月27日 · 4060 次阅读

高级 feature

中英文切换

开发版本与发布版本切换

分配任务

review

todo

嵌入可运行 demo

自定义修改 ztree_toc 配置项

有 Markdown 么 编辑器如何 能 Git 下载到本地吗

看字体就没兴趣

#1 楼 @iBachue 就是把 markdown 转成 html 中得,可以 git 到本地,只要一个命令,即可把 md 文件生成上面的功能。目前还没有集成编辑器,用户的成本只要会 md

#3 楼 @huacnlee 哈哈,我对字体研究太少了,求推荐字体~~

#2 楼 @hz_qiuyuanxin 主要是 js 和 css 的东西,ruby 只是封装了一个命令行工具,目前还不好意思放出源码呢,哈哈

8 楼 已删除

蛮喜欢这款的界面-0- 能不能拖走?

我觉得可以仿 gitbook~

#6 楼 @i5ting 主要是我懒得写 😄

#9 楼 @yldcb ?什么地方可以拖着走?

#11 楼 @hz_qiuyuanxin 月底发吧,留几天时间改改,哈哈

用这个写技术文档应该很方便,坐等楼主发布。

#14 楼 @marksloan 哈哈,确实在让他更多配置,更方便使用

这不是 gitbook 吗

目录和字体抄 gitbook 会好看一些 gitbook 目录的章节是自动编号的, 从截图看这个工具要自己写很蛋疼 自定义功能菜单没什么功能, 又太占地方了, 放广告的咩 目录不高亮当前章节吗?

最怕的就是全文都在一个 md 文件中,要是能按照章节区分 md 文件就好多了

#17 楼 @luikore

目录和字体抄 gitbook 会好看一些

赞一个,放到 todo 里了

gitbook 目录的章节是自动编号的, 从截图看这个工具要自己写很蛋疼

自己写肯定是很蛋疼啊。好在此工具完全是自己动生成的,我们只关心 markdown 内容即可,更多配置都在 jq 插件里

/*
 * ztree的位置,默认是在上部
 */
is_posion_top: true,
/*
 * 默认是否显示header编号
 */
is_auto_number: false,
/*
 * 默认是否展开全部
 */
is_expand_all: true,
/*
 * 是否对选中行,显示高亮效果
 */
is_highlight_selected_line: true,

而且支持多个 md 文件按照顺序拼成一个哦

#! /bin/bash

cat 加密sdk.md  > doc.md
cat 推送sdk.md >> doc.md
cat 版本sdk.md >> doc.md


docsang -f doc.md

自定义功能菜单没什么功能, 又太占地方了, 放广告的咩

此处是亮点,稍后放出的时候再让你惊艳一下,哇哈哈

目录不高亮当前章节吗?

默认目录是在滚动到具体 header 位置是高亮的,不过有还需要改的是,tree 内容不在可视区的时候的定位问题

/*
 * 是否对选中行,显示高亮效果
 */
is_highlight_selected_line: true,

#18 楼 @Victor

最怕的就是全文都在一个 md 文件中,要是能按照章节区分 md 文件就好多了

你说的应该是按照 h1 作为分类,然后像 gitbook 一样的效果吧?目前没有做,写个插件很容易就可以实现,放在 todo 里了

#16 楼 @gothic 呵呵,有点像,不过用途不一样

#21 楼 @sanivbyfish dash 是 api 查询管理的,不一样吧?

之前的 demo,左侧不能滑动

- 0.5.9
    - css minify
- 0.5.8
    - 使用压缩后的js,并在tmpl里增加了gulp构建
- 0.5.7
    - menu不只是可以状态,还支持url
    - example : 'zh':{'icon':'icon-edit','href':'http://baidu.com','target':'_blank','display':"中文"}
- 0.5.6
    - 'fix title update issue'
- 0.5.5
    - if toc_conf file exst,not replace
- 0.5.3
    - 必须把template放到git里,不然gem不包括
- 0.5.2
    - 修正scroll事件绑定的位置问题

#22 楼 @i5ting 现在已经支持文档了

贴个代码地址出来看看

需要 登录 后方可回复, 如果你还没有账号请 注册新账号