Neapolitan Pasta Maker

    @yzfe/gen-doc

    1.0.1 • Public • Published

    yz-gen-doc 同步 markdown 文档到语雀

    同步目录下的 markdown 文件到语雀

    安装

    yarn add @yzfe/gen-doc -D

    全局安装

    npm i @yzfe/gen-doc -g
    yz-gen-doc build $path -n $namespace -t $token

    命令

    npx yz-gen-doc build -h
    yz-gen-doc build <path>
    
    需要生成文档的目录
    
    选项:
      --version, -v    显示版本号                                             [布尔]
      --help, -h                                                              [布尔]
      --namespace, -n  文档存放仓库的 namespace                               [必需]
      --token, -t      语雀的 token, 从 https://www.yuque.com/settings/tokens 取得
                                                                              [必需]
      --apiUrl         语雀接口路径       [默认值: "https://yizhi.yuque.com/api/v2"]
      --include        包含的文件                                [默认值: "**/*.md"]
      --ignore         忽略的文件                [默认值: "**/node_modules/**/*.md"]
    
    

    文档图片

    yz-gen-doc 会将文档里的本地图片,上传到 https://sm.ms/ 图床上

    FAQ

    语雀 token 取得

    访问 https://www.yuque.com/settings/tokens

    namespace

    以 FE 开发文档为例, namespace 为 dev-group/khav4a

    UTOOLS1564037711132.png

    svg 图片

    由于 sm.ms 图床不支持 svg 上传,所以在本地的 svg 文件无法显示

    最佳实践

    把 语雀 token 写到 OS 环境变量里

    示例

    打开 ~/.zshrc~/.bashrc, 加入

    export YUQUE_TOKEN=your yuque token
    
    source ~/.zshrc

    之后就可以这样用

    npx yz-gen-doc build ./dev-packages -n dev-group/khav4a -t $YUQUE_TOKEN

    Keywords

    none

    Install

    npm i @yzfe/gen-doc

    DownloadsWeekly Downloads

    8

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    11 kB

    Total Files

    4

    Last publish

    Collaborators

    • allenice
    • allenmo
    • vfasky