Installation

There is only one way to install the Darkdown as of now. Process is mentioned below.

Build from source using Rust

To build darkdown executable from source, you will first need to install Rust and Cargo. Follow the instructions on the Rust Installation Page.

Once you have installed Rust, the following command can be used to build and install Darkdown: cargo install darkdown

This will automatically download darkdown from crates.io, build it, and install it in Cargo's global binary directory (~/.cargo/bin/ by default).

To uninstall, run the command cargo uninstall darkdown.

Basic Syntax

Headings

With darkdown you can, get the Heading with following syntax

@ Heading

After @ there will be content

Bold Text

Bold content should be between **. for eg.

** Bold Content **

Italic Text

Bold content should be between ^. for eg.

^ Italic Content ^

Code Blocks

Inline code blocks are written in between \

\ Code Block \

List Items

List items starts with >

> List Item 1
> List Item 2