render-gfm
Render (GitHub Flavoured with syntax highlighting) Markdown, and generate CSS for each of GitHub’s themes.
See Example
This version is rendered Markdown, through GitHub Pages alone.
This version is rendered Markdown, using render-gfm.
Install
npm install -g render-gfm
The --global option (-g) is required to globally use the CLI.
✅ This package was written using other packages which were written as ES Modules, causing this to be in ESM as well. See this gist by @sindresorhus for more info.
Usage
Render-gfm can be used programmatically with Javascript, or it can be used at the command line.
API
Import (ESM)
import render from 'render-gfm';
// Using functions other than `render()`:
import { returnRenderedMarkdown(), generateCSS(), writeMarkdown(), writeCSS() } from 'render-gfm';
Usage
/* Examples */
const html = await returnRenderedMarkdown({ file: '../src/README.md', mode: 'gfm' });
// => <Promise<string>> Returns the rendered Markdown in HTML
const themes = await generateCSS();
// => <Promise<Object<string>>> Returns the CSS for each theme, inside an object
await writeMarkdown({ file: 'C:/Users/Owner/Desktop/Project/README.md', mode: 'gfm', output_dir: 'C:/Users/Owner/Desktop/Project/dist' });
// => <Promise<string>> Renders a Markdown file and writes it to an HTML file, then returns directory path to it
await writeCSS({ output_dir: 'C:/Users/Owner/Desktop/Project/assets/css' });
// => <Promise<string>> Generates and writes the CSS for each of GitHub's themes, then returns the path to the CSS files
await render({ file: 'C:/Users/Owner/Desktop/Project/README.md', mode: 'gfm', output_dir: 'C:/Users/Owner/Desktop/Project/dist' });
// => <Promise<string>> Generates CSS and renders Markdown, then writes everything to an output directory
CLI
Assuming render-gfm was installed globally with npm install -g render-gfm, you should now be able to use it from anywhere with your command line.
# Render Markdown and generate CSS
gfm --help
# Only render a Markdown file
gfm markdown --help
# Only generate the CSS
gfm themes --help
# Example - Render a Markdown file and generate CSS, to the output folder "dist" in the current directory
gfm README.md -o dist
# or another example (both relative and absolute paths are allowed)
gfm C:/Users/Owner/Desktop/Project/README.md -o ../dist
Website
To-do
I'll also put this renderer up as a website, to quickly and easily render your Markdown.
License
Copyright © 2022 Shaun Bharat.
This project is licensed with the MIT license.
20 Oct 30, 2022
91 Jan 2, 2023
585 Dec 21, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
43 Jan 6, 2023
14 Dec 22, 2022
6.8k Jan 5, 2023
6 Dec 8, 2022