@fsegurai/marked-extended-typographic v15.2.3

A library of extended typographic features for Marked.js.

@fsegurai/marked-extended-typographic is an extension for Marked.js that adds support for extended typographic characters to easily translate plain ASCII punctuation characters into "smart" typographic punctuation HTML entities.

Table of contents

• Installation
• Usage
  • Basic Usage
  • Configuration Options
• Symbol Reference
  • Special Characters
  • Logical and Mathematical Symbols
  • Typographic Symbols
  • Greek Letters
  • Emoji Symbols
• More Resources
  • Available Extensions
  • Demo Application
• License

Installation

To add @fsegurai/marked-extended-typographic along with Marked.js to your package.json use the following commands.

bun install @fsegurai/marked-extended-typographic marked@^15.0.0 --save

Usage

Basic Usage

Import @fsegurai/marked-extended-typographic and apply it to your Marked instance as shown below.

import { marked } from "marked";
import markedExtendedTypographic from "@fsegurai/marked-extended-typographic";

// or UMD script
// <script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
// <script src="https://cdn.jsdelivr.net/npm/@fsegurai/marked-extended-typographic/lib/index.umd.js"></script>

marked.use(markedExtendedTypographic());

const exampleMarkdown = `
He said, -- \"A 'simple' sentence. . .\" --- unknown

(omega) - (alpha) - (beta)

Copyright (C^) 2024. All rights reserved.
`;

marked.parse(exampleMarkdown);

Configuration Options

You can customize the typographic behavior with several options:

// Default behavior (recommended)
marked.use(markedExtendedTypographic());

// With specific configuration
marked.use(
    markedExtendedTypographic({
        quotes: true, // Enable smart quotes (default: true)
        dashes: true, // Enable smart dashes (default: true)
        ellipses: true, // Enable smart ellipses (default: true)
        attribute: "2", // Typographic style attribute (default: '2')
        outputUnicode: true, // Output Unicode characters instead of HTML entities (default: false)
        customSymbols: {
            // Add custom symbol replacements
            "\\(lambda\\)": "λ",
            "\\(tm\\)": "™",
        },
    }),
);

• attribute: Specifies the typographic style attribute. The default is 2, which uses the lang attribute for language-specific typographic styles.
  • 0 Disables typographic styles.
  • 1 Enable quotes, backticks, dashes and ellipses
  • 2 Same as '1' but with old-school dash behavior (-- for en-dash, --- for em-dash)
  • 3 Same as '1' but with inverted old-school dash behavior (-- for em-dash, --- for en-dash)
  • -1 Special "stupefy" mode that converts typographic characters back to ASCII

Symbol References

The marked-extended-typographic extension supports a wide variety of special symbols that can be added to your markdown using simple text patterns.

Special Characters

Logical and Mathematical Symbols

Typographic Symbols

Greek Letters

Emoji Symbols

Emoji Symbols

Available Extensions

Extension	Package	Version	Description
Accordion	@fsegurai/marked-extended-accordion		Add collapsible accordion sections to your markdown
Alert	@fsegurai/marked-extended-alert		Create styled alert boxes for important information
Footnote	@fsegurai/marked-extended-footnote		Add footnotes with automatic numbering
Lists	@fsegurai/marked-extended-lists		Enhanced list formatting options
Spoiler	@fsegurai/marked-extended-spoiler		Hide content behind spoiler tags
Tables	@fsegurai/marked-extended-tables		Advanced table formatting with cell spanning
Tabs	@fsegurai/marked-extended-tabs		Create tabbed content sections
Timeline	@fsegurai/marked-extended-timeline		Display content in an interactive timeline format
Typographic	@fsegurai/marked-extended-typographic		Improve typography with smart quotes, dashes, and more

Demo Application

To see all extensions in action, check out the [DEMO].

To set up the demo locally, follow the next steps:

git clone https://github.com/fsegurai/marked-extensions.git
bun install
bun start

This will serve the application locally at http://[::1]:8000.

License

Licensed under MIT.