New MarkDown [BETA]

New way to write in markdown

NMD stands for New MarkDown, or for friends, Nicola MarkDown (if Stephen Bourne can name a shell, why can't I name mine NMD?)

• New MarkDown [BETA]
  • Overview
    • Why NMD?
      • Performance
      • Extended Syntax
      • Order with Integrated Dossiers
      • Predefined Styles and Customization
      • Cool Factor
  • NMD x VS Code
  • Getting Started
    • TL;DR
    • Installation
    • NMD CLI
      • Generate a new dossier
        • Markdown to New Markdown
        • Add a new document
        • Reset dossier configuration
      • Compile dossier
        • HTML
  • Develop
  • NMD Syntax
  • Author
  • Contributing
  • License

Overview

NMD is a custom Markdown dialect designed to enhance the classic Markdown syntax with additional features for styling and enriching text. With NMD, you can effortlessly create beautifully formatted text for your projects while enjoying some unique features tailored to modern needs.

NMD is full compatible with CommonMark standard.

Why NMD?

Performance

Being developed in Rust, NMD has incredible performance. In single thread mode, NMD is 10 times faster than the compiler for VS Code, while in multi thread mode it is 20 times faster!

Extended Syntax

NMD introduces new modifiers and components to elevate your document styling.

For example, you can't emphasize section "work in progress" in common mark, but in NMD you can!

You can use TODO modifier to emphasize a missed section:

Alternatively, do you want emphasize a section where you wrote a tip or warning comment? You can use Focus Block

Order with Integrated Dossiers

Keep your documents organized with integrated "dossiers" for more intuitive and structured management.

Predefined Styles and Customization

• Built-in Styles: Choose from three predefined styles like Light, Dark, and Vintage, for a personalized reading experience.

• Styling in Syntax: Apply style directly in the text using NMD syntax.

• Additional Page Styling: Further customize the look of your page with additional styles.

• Easy Integration: Compile NMD files into HTML effortlessly for seamless integration with your web projects.

• Open Source: This compiler is open source under the GPL-3.0 License, allowing you to modify and adapt it to suit your needs.

Cool Factor

Why stick to Markdown when you can be cool using NMD?

NMD x VS Code

You can use the official NMD x VS Code extension!

Getting Started

Do you want migrate from Markdown to New Markdown easily and quickly? Read how to do that using CLI!

TL;DR

nmd generate dossier -p dossier/input/path -f -w

nmd dossier -p dossier/input/path add -d new-document.nmd

nmd compile dossier -i dossier/input/path

Installation

To install NMD, follow these steps:

1. Download the last release based on your operating system
2. Extract files
3. Run nmd execution file

NMD CLI

Generate a new dossier

To generate a new dossier you can use the following command:

nmd generate dossier -p dossier/input/path

There are many flags that you can use in combination with generate dossier. For example, if you want force the generation you can use -f, or if you want a welcome page you can use -w.

nmd generate dossier -p dossier/input/path -f -w

The Git support is planned, but not implemented yet. You can only add .gitkeep files in assets directories using -k.

-n permits to specify dossier name.

Markdown to New Markdown

You can easily convert a standard Markdown file in a New Markdown dossier using --from-md <md-file-path> option.

Add a new document

To add a new document you can use the following command:

nmd dossier -p dossier/input/path add -d new-document.nmd

If the document name doesn't have nmd extension, it will be added automatically.

You can add more than one document at the same time:

nmd dossier -p dossier/input/path add -d new-document-1.nmd -d new-document-2.nmd -d new-document-3.nmd

Reset dossier configuration

nmd dossier -p dossier/input/path reset [ -p ]

-p reset flag to preserve documents list.

Compile dossier

HTML

Compile a dossier in html:

nmd compile -f html dossier -i dossier/input/path -o artifact/output/path

If you watch dossier files and compile them if anything changes, you should use watcher mode (-w option).

Watcher mode compile dossier if any change is captured. Changes are captured only if a minimum time is elapsed. To set minimum time use -t option.

--fast-draft to create a fast draft of dossier, generally compiler takes less time to generate it.

-s <document1> -s <documentN> to compile only a subset of documents in dossier configuration list.

-m permits to specify compilation theme:

• light
• dark
• vintage
• scientific
• none

Develop

Develop check list

NMD Syntax

NMD Syntax

[!WARNING] NMD syntax is working in progress yet, you can contribute following contribution guidelines!

Author

Nicola Ricciardi

Contributing

If you would like to contribute to the development of the NMD compiler, please follow contribution guidelines.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.