marked-terminal

The renderer supports syntax highlighting via cli-highlight. You can pass configuration options for cli-highlight as the second argument to the TerminalRenderer constructor.

// Example of passing highlightOptions as the second argument
new TerminalRenderer(options, highlightOptions);

You can use the -m flag to automatically commit and tag your version changes in Git. The %s placeholder is replaced by the newly bumped version in both the commit message and the tag.

By default, the commit message is v%s and the tag is v%s.

# Auto-commit and tag with default 'v%s' message
$ mversion minor -m

# Auto-commit with a custom message and a custom tag name
$ mversion minor -m 'Bumped to v%s' --tag 'v%s-src'

The mversion command updates the version number in one or all of the following files: package.json, component.json, bower.json, manifest.json, and *.jquery.json.

To get the current version: Run the command without any arguments.

To update the version: You can specify a new semver-valid version string or a release type (major, minor, patch, prerelease, or build).

# Get current version
$ mversion

# Update to a specific version
$ mversion 1.0.1-beta

# Increment the minor version
$ mversion minor

To use marked-terminal as a renderer for marked, install both marked and marked-terminal via npm.

npm install marked marked-terminal

The options object allows you to override default terminal styling (using chalk colors), list formatting, reflow behavior, and more.

Key configuration areas include:

• Colors: Override styles for elements like code, heading, strong, em, etc.
• Lists: A list function to format bullet points and numbers.
• Layout: width (for reflow) and reflowText.
• Tables: tableOptions passed to cli-table3.
• Misc: unescape (to undo entity escaping), emoji support, and tab size.

// Example of overriding a specific style
marked.setOptions({
  renderer: new TerminalRenderer({
    codespan: chalk.underline.magenta
  })
});

To use marked-terminal as a renderer for the marked library, use the markedTerminal function. This function returns an object containing a renderer property that maps all standard Markdown rendering methods to the terminal-optimized versions provided by this package. You can integrate it using marked.use() or marked.setOptions().

import { markedTerminal } from 'marked-terminal';
import { marked } from 'marked';

// Using marked.use()
marked.use(markedTerminal());

// Or using marked.setOptions()
marked.setOptions(markedTerminal());

const output = marked.parse('# Hello Terminal');
console.log(output);

If you are using older versions of marked or a CommonJS environment, instantiate TerminalRenderer and pass it to marked.setOptions via the renderer key.

const marked = require('marked');
const TerminalRenderer = require('marked-terminal');

marked.setOptions({
  // Define custom renderer
  renderer: new TerminalRenderer()
});

// Show the parsed data
console.log(
  marked('# Hello \n This is **markdown** printed in the `terminal`')
);

For modern ESM environments, use marked.use() to register the markedTerminal renderer. You can optionally pass options and highlightOptions to the renderer.

import { marked } from 'marked';
import { markedTerminal } from 'marked-terminal';

marked.use(markedTerminal([options][, highlightOptions]));

marked.parse('# Hello \n This is **markdown** printed in the `terminal`');

The mversion CLI supports the following arguments and flags for version bumping and Git integration.

mversion [ <newversion> | major | minor | patch | prerelease ] [ -m <optional message> ] [ -n | --no-prefix ]

Arguments:
- `<newversion>`: A semver-valid version string.
- `major` | `minor` | `patch` | `prerelease`: Release types to increment the version.

Flags:
- `-m <message>`: Auto-commits and tags the change. Use `%s` as a placeholder for the new version. The default message is `v%s`.
- `--tag` or `-t <tagname>`: Overrides the tag name used for the Git tag. Does not change the commit message behavior.
- `--no-prefix` or `-n`: Sets the tag name without a `v` prefix. Does not change the commit message behavior.