marked-it-cli
Advanced tools
A CLI for marked-it. Performs markdown->HTML and (optionally) TOC generation for a collection of markdown source files.
A command-line interface for marked-it that adds support for conref attributes, uniform headers/footers, and .pdf generation. Check out the full documentation for marked-it.
npm install -g marked-it-cli
You may need to sudo the above command since it installs globally.
marked-it-cli <sourceDirectory> --output=<destinationDirectory> [OPTIONS]
<sourceDirectory>
The path of the directory containing source Markdown files. Subdirectories will be recursed.
--output
The path of the directory to write generated files to. Directory structures from the source directory will be replicated here.
--overwrite
Overwrite output files that already exist
--disable-attributes
Disable processing of Kramdown-style attribute lists
--disable-front-matter
Disable processing of Jekyll-style front matter blocks
--toc-xml
Generate a toc.xml file for directories containing a valid toc file
--toc-depth=<maxHeaderLevel>
Set the maximum header level that will appear in toc files (default=3)
--verbose
Output verbose details
--debug
Output even more verbose details
--gen-pdf
Generate .pdf files
--pdf-options-file=<pdfOptionsFile>
Path to the file with PDF generation options
--header-file=<headerSourceFile>
Path to the file with content to be prepended to the generated .html
--footer-file=<footerSourceFile>
Path to the file with content to be appended to the generated .html
--conref-file=<conrefFile>
Path to the file containing DITA-style variable definitions
For PDF file generation to succeed, wkhtmltopdf must be installed and the path to its binary must be in the OS' PATH environment variable. Note that on Windows the wkhtmltopdf arch (32-/64-bit) must match that of the node.js being used.
If --pdfOptionsFile is not specified then all default options will be used. Custom options are specified in strict JSON format as the camel-cased equivalents of the options described in the wkhtmltopdf options. For an example see included file example/examplePDFoptions.
The "examples" directory demonstrates the CLI's features. To generate it use command:
node ./bin/marked-it-cli ./example --output=./exampleOutput --extension-file=./example/headerFooterExt.js --gen-pdf --pdf-options-file=./example/pdfOptions --keyref-file=./example/keyref.yaml --toc-xml
[2.4.4 and 2.4.5] 2023-11-09
Pick up the latest marked-it-core.
FAQs
A CLI for marked-it. Performs markdown->HTML and (optionally) TOC generation for a collection of markdown source files.
The npm package marked-it-cli receives a total of 246 weekly downloads. As such, marked-it-cli popularity was classified as not popular.
We found that marked-it-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.