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

作为资深 md 工程师,安利一个高颜值的文档神器

  •  
  •   arobota · 2020-05-23 23:21:25 +08:00 · 3702 次点击
    这是一个创建于 1631 天前的主题,其中的信息可能已经有所发展或是发生改变。

    material mkdocs

    又好看,又好用,我都用这个部署博客了

    https://www.leosirius.fun/

    另外打个广告:leetcode 题解,几乎每题都有解题思路和单元测试,不断补充中 https://github.com/LeoSirius/leetcode_solutions

    11 条回复    2020-05-24 20:42:49 +08:00
    yazoox
        1
    yazoox  
       2020-05-24 07:22:24 +08:00
    md 工程师?专业写文档?
    whileFalse
        2
    whileFalse  
       2020-05-24 08:31:58 +08:00
    哥们你这个主页……真是……丑哭了……
    还有就是那个工具,找了 10min 没找到 mkdocs.yaml 的入门写法,于是我流失了。

    一个优秀的新手向导是什么样的?在有一堆 md 文件的目录下执行一条命令即可启动(使用 docker );
    entrypoint.sh 发现没有配置文件,于是自动创建一个最简单的默认配置文件,并自动扫描目录下的 md 文件添加到当前配置文件中;自动创建默认主页教用户最简单的配置文件应该怎么写。
    arobota
        3
    arobota  
    OP
       2020-05-24 10:41:22 +08:00
    arobota
        4
    arobota  
    OP
       2020-05-24 10:42:54 +08:00
    @whileFalse 另外那个站只是记录文档,这个才是主页
    https://www.leosirius.com/
    whileFalse
        5
    whileFalse  
       2020-05-24 10:46:37 +08:00
    @arobota #3 我看到这个文件了,然而 repo 根目录下这个 yml 应该是以展示所有功能为目的编写的,过于复杂,无法在短时间内理解并套用。
    LuckyDee
        6
    LuckyDee  
       2020-05-24 11:10:36 +08:00
    话说老哥你刷了多久刷完的
    fakepoet
        7
    fakepoet  
       2020-05-24 11:54:35 +08:00
    @arobota 主页也不好看啊。。。
    arobota
        8
    arobota  
    OP
       2020-05-24 12:03:29 +08:00
    @LuckyDee 并没刷完。。。
    lscexpress
        9
    lscexpress  
       2020-05-24 12:13:36 +08:00
    他们都说你主页丑,审美不一样,别在意。

    但你的网站是真的慢,即使 304 的情况下,依旧达到了 800ms 。
    tubimasky
        10
    tubimasky  
       2020-05-24 17:23:53 +08:00
    win 下用客户端或者命令行都检出失败
    Clone succeeded, but checkout failed.
    linux 下无问题 是个例吗
    Cloning into 'leetcode_solutions'...
    remote: Enumerating objects: 141, done.
    remote: Counting objects: 100% (141/141), done.
    remote: Compressing objects: 100% (114/114), done.

    Receiving objects: 100% (5195/5195), 13.07 MiB | 174.00 KiB/s, done.
    Resolving deltas: 100% (2321/2321), done.
    error: unable to create file 0057_Insert_Interval /Solution1.cpp: No such file or directory
    error: unable to create file 0057_Insert_Interval /slt.md: No such file or directory
    error: unable to create file 0097_Interleaving_String /Solution1.cpp: No such file or directory
    error: unable to create file 0097_Interleaving_String /slt.md: No such file or directory
    fatal: cannot create directory at '0597_Friend_Requests_I:_Overall_Acceptance_Rate': Invalid argument
    warning: Clone succeeded, but checkout failed.
    You can inspect what was checked out with 'git status'
    and retry with 'git restore --source=HEAD :/'
    MarkLeeyun
        11
    MarkLeeyun  
       2020-05-24 20:42:49 +08:00
    啊哈哈哈哈,难以上手而且慢。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3008 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 32ms · UTC 13:54 · PVG 21:54 · LAX 05:54 · JFK 08:54
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.