Generate HTML & PDF documentation from Github wiki or any other markdown-based wiki.
npm install github-wikito-converterGithub Wikito Converter allows you to generate HTML & PDF documentation from your Github wiki or any other markdown-based wiki. It is build on top of Limedocs Wiki Converter and contains new features and bug fixes, check the release notes to see them.
Check out sample HTML and PDF files generated from okhttp wiki.
- Node.js or io.js
- wkhtmltopdf (only necessary for pdf output format)
Note: The patched-QT version of wkhtmltopdf is required for pdf export. Without it, gwtc output can be found as an empty pdf file. See issue ([#39][i39]) for details.
[i39]: https://github.com/yakivmospan/github-wikito-converter/issues/39
``bash`
npm install -g github-wikito-converter
Download github-wikito-converter sources, open termial at the root the folder, and run:
`bash`
npm run build-and-install-g
`bashClone your github wiki for example
git clone https://github.com/yakivmospan/github-wikito-converter.wiki.git
Usage help
`
Usage: gwtc [options] Convert a wiki
Options:
-h, --help output usage information
-V, --version output the version number
-f, --format Format to convert to. Either html, pdf, or all [default: html]
-o, --output Output dir [default: './']
-n, --file-name Output file name [default: documentation]
-t, --title Wiki title [default: Documentation]
-d, --disable-inline-assets Disable inlining of images, css and js in html document
--logo-img Logo image file
--footer
`
Formats
HTML
$3
By default, Github Wikito Converter will check for the following files to use as a table of contents (TOC):
-
_Toc.md
- _Sidebar.md (which is the default sidebar file on Github wikis)When finding a TOC, gwtc will only generate pages linked from this TOC. Supported link formats are:
- Markdown links with local path
Call Log / Log / Calls;
- Markdown links with remote (http/https) path Calls.
Only those links that are placed in TOC will be converted to local page ids;
- Github wiki links [[Call Log]] / [[Call-Log]] / [[Call Log|Call-Log]] / [[Log|Call Log]].$3
By default, the HTML output format will generate a single-page HTML document of you wiki, with all assets inlined, such
as images, css, and javascript. So all you need to transfer documentation (to a colleague for example) is to send him/her
this unique file.
You can disable this inlining feature by passing
--disable-inline-assets (or -d) such as several files will be
generated for each of images, css and javascript files.$3
The TOC is rendered using a fixed div in the HTML documentation. You can use
--toc-level to prevent the TOC div
to overlap the body element.PDF
$3
PDF rendering is done using
wkhtmltopdf which should be available in your PATH.
It simply renders (more or less) the HTML version of your doc in PDF.$3
By default all TOC pages starts from a new page. Also with default
css you will never see your code block or image
broken in two pages. To add additional page breaking use style="page-break-before: always !important; with empty div element.Before :
`md
Interceptors
Interceptors are a powerful mechanism that can monitor, rewrite, and retry calls. Here's a simple interceptor that logs the outgoing request and the incoming response.
`
After :
`md
Interceptors
Interceptors are a powerful mechanism that can monitor, rewrite, and retry calls. Here's a simple interceptor that logs the outgoing request and the incoming response.
`
Code highlighting
Code highlighting is rendered using highlight.js.
You can customize the theme used by using the
--highlight-theme option. By default, github` theme is used.