Markdown2Pdf.Console 2.0.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet tool install --global Markdown2Pdf.Console --version 2.0.2
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local Markdown2Pdf.Console --version 2.0.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=Markdown2Pdf.Console&version=2.0.2                

                    
                

            
nuke :add-package Markdown2Pdf.Console --version 2.0.2

<h1 align="center">Markdown2Pdf.Console</h1>

<p align="center"> <img src="./assets/md2pdf-console.svg" alt="Logo" Width=128px/> <br> </p>

Command-line application for converting Markdown to PDF, using Markdown2Pdf.

Installation

This app can be installed as a dotnet tool:

dotnet tool install --global Markdown2Pdf.Console

<br>

Alternatively the latest builds for Windows and Linux can be downloaded at Releases.

Getting started

Convert a Markdown-File:

md2pdf "README.md" # Outputs README.pdf

Open Help:

md2pdf --help # Displays all options

For detailed information please refer to the Markdown2Pdf Wiki.

Usage

md2pdf <input-path> [<output-path>] [options]

Arguments

Arguments:
  <input-path>   The path to the markdown file to parse.
  <output-path>  Path where the PDF file should be generated. If not set, defaults to <markdown-filename>.pdf.

Options

  -y, --options-from-yaml-front-matter                        If set, loads the options from a YAML front matter block. See https://github.com/Flayms/Markdown2Pdf/wiki/Markdown2Pdf.Markdown2PdfConverter#-createwithinlineoptionsfromfilestring
  -h, --header-path <header-path>                             Path to an html-file to use as the document-header.
  -f, --footer-path <footer-path>                             Path to an html-file to use as the document-footer.
  -o, --open-after-conversion                                 If enabled, opens the generated pdf after execution.
  -m, --margins <margins>                                     Css-Margins for the content in the pdf to generate. Values must be comma-separated. [default: 50px]
  -c, --chrome-path <chrome-path>                             Path to chrome or chromium executable. Downloads it by itself if not set.
  -k, --keep-html                                             If this is set, the temporary html file does not get deleted.
  -t, --theme <theme>                                         The theme to use for styling the document. Can either be a predefined value (github, latex) or a path to a custom css.
  --code-highlight-theme <code-highlight-theme>               The theme to use for styling the markdown code-blocks. Valid Values: See https://github.com/Flayms/Markdown2Pdf/wiki/Markdown2Pdf.Options.CodeHighlightTheme for an overview of all themes.
  --document-title <document-title>                           The title of this document. Can be injected into the header / footer by adding the class document-title to the element.
  --custom-head-content <custom-head-content>                 A string containing any content valid inside an html <head> to apply extra scripting / styling to the document.
  -l, --is-landscape                                          Paper orientation.
  --format <format>                                           The paper format for the PDF. Valid values: Letter, Legal, Tabloid, Ledger, A0-A6.
  -s, --scale <scale>                                         Scale of the content. Must be between 0.1 and 2.
  --toc-min-depth <toc-min-depth>                             The minimum level of heading depth to include in the TOC (e.g. 1 will only include headings greater than or equal to <h1>). Range: 1 to 6.
  --toc-max-depth <toc-max-depth>                             The maximum level of heading depth to include in the TOC (e.g. 3 will include headings less than or equal to <h3>). Range: 1 to 6.
  --toc-list-style <Decimal|None|OrderedDefault|Unordered>    Decides which characters to use before the TOC items.
  --toc-has-colored-links                                     Determines if the TOC links should have the default link color (instead of looking  like normal text).
  --toc-page-numbers-tab-leader <Dashes|Dots|None|Underline>  Generate TOC Page Numbers and use the given character to lead from the TOC title to the page number.
  --version                                                   Show version information
  -?, -h, --help                                              Show help and usage information

[!NOTE]
Note: setting any of the --toc options will cause a TOC to be generated within the placeholders.

[!TIP] All the options can also be directly embedded in the Markdown with a YAML front matter block. See Example.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
2.0.2 190 12/3/2024