Markdown
Markdown is a lightweight markup language. It offers an easy-to-read and easy-to-write syntax in its unformatted form. It is possible to add YAML metadata at the beginning of the file.
In programming, Markdown is the preferred format for writing the documentation websites as well as the README.md files, the main entry points of the projects. Markdown is also used to write the pages of static websites (Wikipedia), as well as forums, messaging or knowledge bases and note-taking tools.
Example of Markdown code:
# Title 1
Some text
1. Ordered list 1
1. Ordered list 2
## Title 2
- Unordered list 1
- Unordered list 2
The result in html is the following:
<h1 id="title-1">Title 1</h1>
<p>Some text</p>
<ol>
<li>Ordered list 1</li>
<li>Ordered list 2</li>
</ol>
<h2 id="titre-2">Titre 2</h2>
<ul>
<li>Unordered list 1</li>
<li>Unordered list 2</li>
</ul>
<blockquote>
<p>Blockquote </p>
</blockquote>
- Learn more
- Wikipedia
Related articles
Gatsby.js, React and GraphQL for documentation websites
Categories: Adaltas Summit 2018, Front End | Tags: Gatsby, HTTP, JAMstack, React.js, SEO, API, GitOps, GraphQL, JavaScript, Markdown, Node.js
In the last few months, I have started to redesign some of our Open Source project websites. This includes the websites of the Node.js CSV project, the Node.js HBase client and the Nikita project, ourā¦
By David WORMS
Apr 1, 2019
Publishing guidelines
Categories: DevOps & SRE | Tags: Arch Linux, KVM, VM, Vagrant, Markdown
This is as much a set of guidelines targeting everyone publishing content on the web as rules for reviewers to ensure no validation is forgotten before submitting for publication. It mostly targetsā¦
By David WORMS
Feb 28, 2018
Node CSV version 0.1 and future developments
Categories: Node.js | Tags: CoffeeScript, CSV, Markdown, Release and features, Streaming
The Node CSV parser has just reach version 0.1 which close the 0.0.x releases. Started almost 2 years ago, the project has received a tremendous amount of participation in the form of bug reportsā¦
By David WORMS
Jul 21, 2012
Node CSV version 0.2 with streaming API
Categories: Node.js | Tags: Data Engineering, CSV, Markdown, Node.js, Streaming
The Node CSV parser in its version 0.2 has just been released. This version is a major enhancement as it aligned the parser with the best Node.js practice in respect of streams. The CSV parser behaveā¦
By David WORMS
Jul 2, 2012