首页   注册   登录
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
拉钩
V2EX  ›  程序员

你是用什么工具写格式丰富的文档的?

  •  1
     
  •   jdhao · 10 天前 · 4009 次点击

    很早之前使用 Word 写东西,但是 Word 真的好蛋疼,对代码段之类的支持很差,后面开始用有道云笔记,但是对代码段的支持也是差强人意(现在貌似可以了,很久不用了),而且启动速度比较慢,不流畅。后面也用过为知笔记,不流畅,界面做的也不是很美观。

    大约一年多以前,下定决心,开始使用 Markdown 配合 Pandoc 来写自己的笔记和平时的一些心得体会,后面还写了一篇博客讲述自己的配置,Markdown 书写采用 Sublime Text 配合一些插件,也写了一篇博客总结自己常用的插件以及配置等等。

    但是如果自己要写周报,或者什么报告,Markdown 对图片排版,还有表格,以及公式的支持就不是很好,要写作包含丰富图片,复杂表格的文档,就有点蛋疼了,用 LaTeX 写作?略微有点重啊。。不是很 light-weight.

    大家都是怎么操作的?

    为啥刚才选的节点是“程序员”,结果发出来跑到“调查”了?

    77 回复  |  直到 2018-12-07 19:03:19 +08:00
        1
    longbye0   10 天前 via Android
    latex 不重,很多同学课程作业都用
        2
    hronro   10 天前   ♥ 1
    如果对 vue 熟悉的话,可以尝试 vuepress,可以自己写组件增强 markdown 格式,而且其实 vuepress 默认情况下也已经很好用了
        3
    szzhiyang   10 天前   ♥ 2
    我正在开发一个 Word 插件专门来摆平 Word 对代码段支持不够好的问题,请有相关需求的朋友给我点支持和鼓励!这样我就有动力做好这件事情了。😀
        4
    rosu   10 天前 via Android
    如果你使用 typora 的话,公式支持还是挺不错的
        5
    shapl   10 天前
    语雀挺好的。
        6
    luozic   10 天前
    vscode +latex
        7
    jdhao   10 天前
    @longbye0 相对于 Markdown 还是比较重的。

    @hronro 不懂前端,另外我不是写博客,这是记录一下日常的笔记以及一些文档。
    @szzhiyang 是吗,感觉背景,以及语法高亮在 Word 就不太好弄,公式现在已经有一些不错的 LaTeX 插件了。

    @rosu Markdown 对复杂图片和 table 的支持不行。

    @shapl 试了一下,还是同样的问题,对图片和表格的支持不足,例如,你怎么方便地输入图片和 table 的标题,并且方便的对齐。
        8
    rosu   10 天前 via Android
    @jdhao 问题在于,既然 markdown 都无法满足你...那就说明你的写作要求本来就很重。那你就不应该在 markdown 或类似工具上寻找解决方案不是吗...
        9
    di1012   10 天前
    俺都是用 txt
        10
    jdhao   10 天前
    @rosu 看来只能 LaTeX 了。。。
        11
    jdhao   10 天前
    @luozic LaTeX 是用的 TeXLive?? Windows 系统?
        12
    raysonx   10 天前 via iPad   ♥ 1
    差强人意=基本令人满意
        13
    zorrobei   10 天前
    为什么不分工?笔记用 MD,报告用 Word,office 成为办公软件的霸主不是没有原因的
        14
    0attocs   10 天前
    md 解决不了的用 LaTeX 或 word。没有 LaTeX 环境、模板的话可以用 overleaf 在线写。

    ps: 不是 word 支持不好,你只是不会用 word。很多编辑器都支持直接复制富文本,复制进 word 改下行距行号就可以。word 和 LaTeX 各有各的优势。
        15
    jdhao   10 天前
    @0attocs 代码段的背景以及语法高亮能复制进 word 里面?截个图看看。LaTeX 倒是可以使用在线的编辑器,这个不错。

    @zorrobei 主要是 word 这种用起来蛋疼,调整格式比较麻烦,不能通过命令。

    @raysonx 嗯,基本满意。
        16
    hnbcinfo   10 天前
    你可以选择 LaTex,当年为了论文还专门学过,后来长时间不用,现在都不知道怎么用了
        17
    szzhiyang   10 天前
    @jdhao 我觉得可以尝试一下,Word 插件能做到的事情还是挺多的。这样能解决 Word 弊端的插件应该会很受欢迎的,毕竟相比其他更复杂的工具,Word 用起来还是更舒服一些。
        18
    hexingb   10 天前
    会 Python,就用 Sphinx
    用 Emacs,就用 Org Mode
    两个都可以导出 html 和 pdf。
        19
    jdhao   10 天前
    @szzhiyang word 对于初学者友好,毕竟 what you see is what you get.

    @hexingb Sphinx 似乎更适合写 package 的文档,而不是单个笔记。
        20
    jasonyang9   10 天前
    gvim 写 Markdown,Firefox 加 GitLab Markdown Viewer 看效果。Word 早放弃了,之前还精心调制了很多样式和模板
        21
    labnotok   10 天前 via Android
    windows 画图
        22
    hexingb   10 天前
    @jdhao 我自己是习惯了 emacs,所以 org mode 是我的选择。当然交给别人正式的东西,还是要用 word。
        23
    kooze   10 天前
    Bear
        24
    jdhao   10 天前
    @hexingb 我之前试过 pandoc 把 Markdown 转为 Word,格式还可以,有的地方还需要微调一下。
        25
    omph   10 天前
    light-weight 却支持复杂图表,本身就是矛盾的要求
    需求可以改成:寻找和 word 兼容性好的轻量级笔记工具
        26
    Vegetable   10 天前
    vscode 目前复制出来的默认是富文本,粘贴到 word 还是可以的,排版的确是个问题,但是总比直接写进去强.其他的编辑器应该也可以导出富文本,我之前是用 notepad++.
        27
    lastpass   10 天前 via Android
    就 word 呀。
    word 本身就能读 html,css。
    可以试试 planetb( http://www.planetb.ca/syntax-highlight-word)
    配合 word 使用。
        28
    turingmachine   10 天前
    可以尝试下用 gitbook, 比起一般的 markdown, 他还支持视频,表格插件,公式也支持。用起来挺不错。便于自己记录,也可以分享给别人。我用了个 docker 的部署,https://github.com/ChineseTeapot/gitbook。
        29
    VShawn   10 天前
    给人看的用 WORD
    自己看的用 ONENOTE
        30
    daijinming   10 天前
    用这个 https://notepad2.cn 试试
        31
    wenzhoou   10 天前 via Android
        32
    lauix   10 天前
    正在做一个基于,markdown 的 书籍生成工具
        33
    skmO   10 天前
    Scrivener?
    写过论文
    不过复杂图片和表格的支持我也不熟
        34
    jdhao   10 天前
    @lastpass 这个可以试试。
    @turingmachine 本质还是 Markdown 啊,要排版图片就有点捉急了。
    @daijinming 太简陋了,啥功能都没有。

    @wenzhoou Markdown 的图片和表格功能我都熟悉,要制作复杂图片(譬如三张图片并排)和复杂表格,就比较困难了。

    @skmO 收费的。用这个不如直接 LaTeX 搞起了。
        35
    shyangs   10 天前
    wiki 可以做复杂表格
        36
    vonsdite   10 天前
    写笔记。。 可以尝试用 OneNote, 各种设备都能查看到自己的笔记
        37
    qinyusen   10 天前   ♥ 1
    有一个毛子的项目特别好。

    markdown + latex

    sample: https://upmath.me/

    供参考。
        38
    jdhao   10 天前 via Android
    @qinyusen 这个看起来很不错的样子
        39
    likuku   9 天前
    Google docs
        40
    kAzec   9 天前 via iPhone
    朋友,Notion 了解过吗?我觉得在简洁和实用之间做的还算挺平衡的。我自己现在 To-Do, Notes, Project, Blog 都在上面。就是性能还有待优化,Electron 写的东西,用着用着就自动重载了。
        41
    ericls   9 天前 via iPhone
    @raysonx 我觉得现在应该 deprecated 这个词的原义
        42
    tomychen   9 天前
        43
    jdhao   9 天前
    @tomychen 不应该是 vim 或者 neovim 吗。。。。
        44
    tomychen   9 天前
    @jdhao 装好系统第一件事就是
    mv /bin/vi /bin/vi.orig
    ln -s /opt/local/bin/vim /bin/vi
        45
    tamlok   9 天前 via Android
    @tomychen 不应该是 alias 吗?
        46
    haisua   9 天前
    很多年前我是专业的 Technical Writer,用过几种标记语言,现在看来,难度适宜,格式也较丰富的,我推荐的是 Sphinx RestructuredText,也就是 Python 官方文档采用的那种标记语言。
        47
    RockyLee   9 天前 via Android
    居然没人说 asciidoc
        48
    Fulcrum   9 天前 via Android
    marktext
    markdown 编辑器
    支持多行 Latex
    支持输出 pdf
    支持 yaml
    可以试下
        49
    turingmachine   9 天前
    @jdhao 因为有插件可以控制下,也直接支持 html。 @RockyLee gitbook 也支持 asciidoc
        50
    liuxliang   9 天前
    让工具做自己擅长的事,没必要找个面面俱到的
        51
    abclucifer   9 天前
    没有很重的文档需求,平时就用 Markdown 足够了
        52
    chickplilita   9 天前


    typora。支持不错
        53
    eliteYang   9 天前
    markdown + docsify + docsify-plugins
        54
    star7th   9 天前
    ### ShowDoc 是什么

    每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!**Show me the doc !!**

    程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的 word 文档放在哪个目录等各种非技术细节。

    word 文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上 qq 或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。

    ShowDoc 就是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。

    ### 它可以用来做什么

    - API 文档( [查看 Demo]( http://www.showdoc.cc/2))

    随着移动互联网的发展,BaaS (后端即服务)越来越流行。服务端提供 API,APP 端或者网页前端便可方便调用数据。用 ShowDoc 可以非常方便快速地编写出美观的 API 文档,同时还将支持从代码文件中自动生成 API 文档

    - 数据字典( [查看 Demo]( http://www.showdoc.cc/1))

    一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。

    - 说明文档([查看 Demo]( http://www.showdoc.cc/3) )

    你完全可以使用 showdoc 来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

    ### 它都有些什么功能


    - ** 分享与导出 **

    - 响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成 word 文件,以便离线浏览。

    - ** 权限管理 **
    - 公开项目与私密项目

    ShowDoc 上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。

    - 项目转让

    项目创建者可以自由地把项目转让给网站的其他用户。

    - 项目成员

    你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
    - 团队管理
    你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。

    - ** 编辑功能 **
    - markdown 编辑

    ShowDoc 采用 markdown 编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解 Markdown,请在搜索引擎搜索"认识与入门 Markdown"

    - 模板插入

    在 ShowDoc 的编辑页面,点击编辑器上方的按钮可方便地插入 API 接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。

    - 历史版本

    ShowDoc 为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。


    ### 安装到自己的服务器


    - 安装手册:[https://www.showdoc.cc/help?page_id=13732]( https://www.showdoc.cc/help?page_id=13732)
    - 若觉得 showdoc 好用,不妨点个 star。良好的关注度和参与度有助于开源项目的长远发展。开源地址: https://github.com/star7th/showdoc



    ### 使用在线的 ShowDoc

    - 如果你没有自己的服务器,但又想使用 ShowDoc 作为分档分享工具,你可以使用在线的 ShowDoc [http://www.showdoc.cc]( http://www.showdoc.cc/home/user/login)

    - http://www.showdoc.cc 作为在线服务会长期维护,请放心托管你的文档数据。使用在线服务时请记住 showdoc 唯一官方网址 https://www.showdoc.cc
        55
    oska874   9 天前
    office 真香
        56
    tailf   9 天前
    Confluence 你值得拥有
        57
    jdhao   9 天前
    @kAzec 相当于是把各种需求整合起来了,不过目前暂时用不到。。
    @haisua restructuredText 可以学一下,做出来的文档不错,公式貌似也可以很好显示

    @Fulcrum Markdown 编辑器好多啊,相对于 vnote 有啥优势,vnote 貌似也不错,对公式支持很好。

    @chickplilita 不怎么使用印象笔记,倾向于开源软件。
        58
    jdhao   9 天前
    @tailf 公司目前在用,但是个人在家就没法使用,而且 confluence 对 公式支持并不好,有一个免费的 Markdown 宏,但是功能很弱,并不比其他的 Markdown 编辑器功能强。
        59
    zhaogaz   9 天前
    讲道理,markdown 设计目标是为了简化 html,顺带夹杂了程序员自己的一点私活.功能上很弱的.

    从这个角度看就能理解了,

    之前我有个想法,本来想用 markdown 来写,后来找了半天,不让人满意.
        60
    jdhao   9 天前
    @zhaogaz 后来呢,后来咋弄了。。
        61
    hJohn   9 天前
    试试这个 说不准太轻了
    notion.so
        62
    defel   9 天前 via iPhone
    我用的就是 latex,连公式推导都用,毕竟板式好看,自己才会看,不然自己都觉得不想看。
        63
    iyaozhen   9 天前 via Android
    想起来大学时使用 notepad+哦+往 word 里面复制格式优雅的代码。
    https://iyaozhen.com/code-to-word.html
        64
    jdhao   9 天前
    @hJohn 嗯,前面有人提到了,不过看了一下更适合团队合作那种,写文档不一定比一般的 Markdown 功能上更强大。

    @defel LaTeX 排版出来的还是很精美的,没有什么能超越的吧。。

    @iyaozhen 赞,这个不错,还不知道有这个功能。
        65
    SeaRecluse   9 天前
    word + ppt + excel
    文档中必须要大量代码块的话,我选择写完复制。
        66
    leexiaoran   9 天前
    emcas 的 org-mode 也挺好的
        67
    jdhao   9 天前
    @leexiaoran 没用过 emacs,我一直用 Neovim。
        68
    laqow   9 天前 via Android
    记笔记的话 markdown+pandoc 写,写不了就写点 html,再写不了就模板挂 mathjax 接着写,要 pdf 就写完导 html 再打印
        69
    narcotics   9 天前
    @ericls #41 因为用错的人多就应该将错就错的想法我不是很认同。

    另,“应该”后面应该接动词原型 ;)
        70
    imgwh   9 天前
        71
    leavic   9 天前
    latex 准备一个常用的模板,需要的时候套上文字就行了。
        72
    no1xsyzy   9 天前
    那么是多复杂的图表呢?我想不出 PFM 不支持的……

    #7 怎么方便地输入图片和 table 的标题,并且方便的对齐?
    ![标题](path/to/picture)
    自然对齐。
        73
    jdhao   9 天前
    @no1xsyzy 譬如,三张图片要放在一行对齐,你用 Markdown 就很捉急,table 的话如果要做样式复杂的表格,不是简单的 几行几列很规整的表格,markdown 同样捉急。
        74
    no1xsyzy   9 天前
    @jdhao 子 figure …… 类似这样: https://lierdakil.github.io/pandoc-crossref/#subfigures
    注意设置图片宽度 <=33%
        75
    waterlaw   9 天前 via Android
    Texmacs 公式支持好,Markdown 写书 GitBook + Github
        76
    jdhao   9 天前
    @waterlaw 第一次听说这个工具,之前有一个 https://www.lyx.org/Development,是不是和这个比较类似,都是 WYSIWYG
        77
    cxbig   9 天前
    GitBook +1
    关于   ·   FAQ   ·   API   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   1865 人在线   最高记录 4019   ·  
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.1 · 26ms · UTC 15:58 · PVG 23:58 · LAX 07:58 · JFK 10:58
    ♥ Do have faith in what you're doing.
    沪ICP备16043287号-1