V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
qingv
V2EX  ›  分享创造

docsify - 无需构建、轻量级的文档生成工具

  •  2
     
  •   qingv · 2016-11-26 19:19:57 +08:00 · 9333 次点击
    这是一个创建于 2903 天前的主题,其中的信息可能已经有所发展或是发生改变。

    一般习惯写小工具项目时写完文档就想弄一个页面出来,用 GitBook 感觉太重, GitHub 自带的又不支持多页(额好像是)。所以写了个小工具,部署后可以动态把 Markdown 文件渲染成网页。

    screen shot 2016-11-26 at 18 56 11

    好处就是只需要增加一个 html 入口文件,开启 GitHub 的 Pages 功能(选择 docs 作为源码目录)写完文档直接推送到仓库上就得到了一份文档网站 😄

    目前提供 vue 和 buble 风格两套主题,还提供了命令行工具方便本地预览,欢迎尝试~

    22 条回复    2016-12-23 00:44:30 +08:00
    neoz
        1
    neoz  
       2016-11-26 19:51:59 +08:00 via iPhone
    不错诶,赞!一会仔细看下
    Kilerd
        2
    Kilerd  
       2016-11-26 20:12:18 +08:00 via Android
    这套主题很好看!
    airyland
        3
    airyland  
       2016-11-26 20:31:11 +08:00 via iPhone
    gimp
        4
    gimp  
       2016-11-26 22:16:03 +08:00
    很棒,收藏了
    wq2016
        5
    wq2016  
       2016-11-26 22:30:32 +08:00
    支持!
    DarsyCheuk
        6
    DarsyCheuk  
       2016-11-26 22:47:40 +08:00 via iPhone
    mark
    huangfuyingjian
        7
    huangfuyingjian  
       2016-11-26 23:09:59 +08:00
    很漂亮的主题,滋瓷一个,已 Star :)
    mingyun
        8
    mingyun  
       2016-11-26 23:52:35 +08:00
    不使用 username.github.io 使用其他 repo 的 gh-pages 分支可以吗
    qingv
        9
    qingv  
    OP
       2016-11-27 06:18:02 +08:00 via iPhone
    @mingyun 都可以呀 做法一样
    levie
        10
    levie  
       2016-11-27 11:55:24 +08:00
    赞赞赞!
    不知道能否设置左边的导航栏到 4 级(即 ####)就不要展开了?
    因为想写成 FAQ 形式的,如果都展开的话就太占空间了。
    qingv
        11
    qingv  
    OP
       2016-11-27 12:06:37 +08:00 via iPhone
    @levie 自己写样式覆盖咯
    qingv
        12
    qingv  
    OP
       2016-11-27 12:09:52 +08:00 via iPhone
    @levie 想了下似乎可以设置成选项,下一个 patch 加上
    levie
        13
    levie  
       2016-11-27 12:40:57 +08:00
    @qingv 谢谢
    levie
        14
    levie  
       2016-11-27 12:45:45 +08:00
    另外,我这样写的时候:

    ## [ABC](/abc)

    解析有问题(左边导航栏以及正文内容都是)
    这样写是希望每个页面都有相同的导航栏,出现在正文内容的可以我通过 css 屏蔽掉。
    qingv
        15
    qingv  
    OP
       2016-11-27 14:03:12 +08:00   ❤️ 1
    @levie
    目录最大层级功能已加, heading 渲染问题也修复了,已发布 0.3.1 。有 bug 或 feature 可以到 issue 里提 😄
    levie
        16
    levie  
       2016-11-27 14:16:04 +08:00
    @qingv
    赞!好的~
    guyskk
        17
    guyskk  
       2016-11-27 19:20:04 +08:00 via Android
    手机 chrome 上代码块无法水平滚动
    yuanchao
        18
    yuanchao  
       2016-11-28 13:57:13 +08:00
    mark
    levie
        19
    levie  
       2016-12-01 11:34:33 +08:00
    非常感谢 @qingv 这几日的更新,确实是非常好用的文档生成工具!
    Snipaste 文档: https://docs.snipaste.com/zh-cn
    lawmil
        20
    lawmil  
       2016-12-19 18:02:52 +08:00
    @qingv 貌似最近 1.1.0 好像有问题了。求更新,刚想试试
    qingv
        21
    qingv  
    OP
       2016-12-20 08:24:21 +08:00 via iPhone
    @lawmil 什么问题?
    kamal
        22
    kamal  
       2016-12-23 00:44:30 +08:00
    感谢分享,不用编译部署真方便。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1120 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 18:57 · PVG 02:57 · LAX 10:57 · JFK 13:57
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.