Markdown To Pdf Npm
Github 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.
Add 'markdown-pdf.convertOnSave': true option to settings.json; Restart Visual Studio Code; Open the Markdown file; Auto convert on save; Extension Settings. Visual Studio Code User and Workspace Settings. Select File Preferences UserSettings or Workspace Settings; Find markdown-pdf settings in the Default Settings; Copy markdown-pdf. settings. Npm install gitbook-pdf -g. Gitbook: Command line utility for generating books and exercises using GitHub/Git and Markdown. Running the above command yields a pdf document with some content as the following: Introduction Lorem ipsum dolor sit amet, scelerisque natoque, in etiam erat nibh lacus, Is there a fast way of converting a markdown(.md) file to pdf with word-wrapping (similar to the way done in here )? Note: elevated (sudo) permissions may be needed for npm install -g. Usage Usage: markdown-pdf options markdown-file-path Options: -h, -help output usage information -V, -version output the version number markdown-file-path Path of the markdown file to convert -c, -cwd path Current working directory -p, -phantom-path path Path to.
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. See issue (#39) for details.
Public version
Local version
Download github-wikito-converter
sources, open termial
at the root the folder, and run:
Basic usage
Usage help
HTML
Pages to be included in the documentation
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](Call-Log)
/[Log](Call-Log.md)
/[Calls](/Call-Log.md)
; - Markdown links with remote (http/https) path
[Calls](https://github.com/yourrepo/someproject/wiki/Call-Log)
.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]]
.
Inlining
By default, the HTML output format will generate a single-page HTML document of you wiki, with all assets inlined, suchas images, css, and javascript. So all you need to transfer documentation (to a colleague for example) is to send him/herthis unique file.
You can disable this inlining feature by passing --disable-inline-assets
(or -d
) such as several files will begenerated for each of images, css and javascript files.
Table of contents (TOC)
The TOC is rendered using a fixed div in the HTML documentation. You can use --toc-level
to prevent the TOC divto overlap the body
element.
Md File To Pdf
Rendering
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.
Page breaking
By default all TOC pages starts from a new page. Also with default css
you will never see your code block or imagebroken in two pages. To add additional page breaking use style='page-break-before: always !important;
with empty div
element.
Before :
After :
Markdown To Pdf Windows
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.