Git Product home page Git Product logo

nmd's Introduction

Logo

New MarkDown

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?)

Important

TL;DR: download last NMD CLI tool.

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 2 times faster than the compiler for VS Code, while in multi thread mode it is up to 10 times faster, but having more features as more modifiers, integrated table of content and bibliography!

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:

TODO modifier

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

Focus Block modifier

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?

Syntax

You can find the current NMD's syntax to build nmd documents go to this link.

NMD command line interface

You can download last release of NMD command line interface here or download it through Cargo:

cargo install nmd

NMD x VS Code

You can use the official NMD x VS Code extension!

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.

nmd's People

Contributors

nricciardi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.