Question 1

How do I install and run Pen to preview a Markdown file?

Accepted Answer

Install it globally with npm i -g pen, then run pen filename.md to launch the server and open in your default browser. For a quick try, use npx pen without installation.

Question 2

Does Pen support GitHub Flavored Markdown (GFM)?

Accepted Answer

Yes, through optional Pandoc integration by running pen --pandoc gfm filename.md. The default markdown-it parser may require additional plugins for full GFM support.

Question 3

How can I change the default port in Pen?

Accepted Answer

The README doesn't specify port change options, but check the help with pen -h for available flags. Command-line tools like this often allow port specification via arguments.

Question 4

Pen vs other Markdown previewers like Typora or VS Code extensions?

Accepted Answer

Pen is a lightweight, command-line tool using React for incremental updates to avoid full reloads. Typora is a full GUI editor, and VS Code extensions are IDE-integrated, offering more features but with higher resource usage.

Question 5

How to use Pandoc with Pen for advanced formatting?

Accepted Answer

Use the --pandoc flag followed by a Pandoc format, e.g., pen --pandoc gfm README.md. Ensure Pandoc is installed on your system for this to work properly.

Question 6

Can Pen preview multiple files simultaneously?

Accepted Answer

Pen serves files from the directory it's run in, so you can access multiple files via the browser at localhost:6060, but it's optimized for single-file live preview during editing sessions.

pen

What is pen?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions