GitHub Wiki制作PDF

GitHub Wiki制作PDF

需求

将GitHub的wiki导出PDF打印出来看

工具

主要工具:github-wikito-converter
辅助工具:wkhtmltopdf

步骤

  1. 下载wiki
    1
    2
    ## wiki可以通过git克隆,一般在wiki的右下角
    git clone github.com/xxx/yyy.wiki.git
  2. 安装wkhtmltopdf
  3. 将wkhtmltopdf加入环境变量
  4. 安装node
  5. npm安装github-wikito-converter
    1
    npm install -g github-wikito-converter
  6. 利用github-wikito-converter导出PDF
    命令:
    1
    2
    ## NAME是输出的pdf文件名,TITLE是PDF内容的标题,PATH是wiki的路径
    gwtc -f pdf -n NAME -t TITLE -v PATH

    github-wikito-converter的帮助手册
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    Usage: gwtc [options] <wiki-dir>

    Convert a wiki

    Options:
    -V, --version output the version number
    -f, --format <format> Format to convert to. Either html, pdf, or all [default: html] (default: "html")
    -o, --output <output-dir> Output dir [default: './'] (default: "./")
    -n, --file-name <file-name> Output file name [default: 'documentation'] (default: "documentation")
    -t, --title <title> Wiki title [default: Documentation] (default: "Documentation ")
    -d, --disable-inline-assets Disable inlining of css & js in html document
    --logo-img <logo-file> Logo image file
    --footer <footer> Wiki footer
    --pdf-page-count Enable PDF page count
    --toc <toc-file> Wiki TOC file
    --toctitle <toc title> Title of the toc [default: Table of contents] (default: "Table of contents")
    --toc-level <level> Table of contents deep level [default: 3] (default: 3)
    --highlight-theme <theme> Highlighter theme [default: github] (default: "github")
    --css <css-file> Additional CSS file
    -v --verbose Verbose mode
    -h, --help output usage information