Markdown Syntax Guide

4 min read
Apr 9, 2022

Markdown is a lightweight markup language that allows you to format text in a plain-text editor while still having a structured and readable output. It is often used for writing documentation, readme files, blog posts, and other content where readability and simplicity are important. Markdown syntax is simple and intuitive, making it an ideal choice for writing and formatting text without the need for complex HTML tags. Its flexibility and ease of use make it a popular tool among developers, writers, and content creators alike. By using basic symbols and characters, you can structure documents that are both human-readable and machine-readable, which is crucial for version control and collaborative projects. Markdown also supports extensions and customizations, allowing for a wide range of formatting options without adding unnecessary complexity.

Headers

  • Headers in Markdown Syntax
mdarticle.md
Copy code
# H1
## H2
### H3
#### H4
##### H5
###### H6

Emphasis

  • Emphasis in Markdown Syntax:
mdarticle.py
Copy code
*italic*
**bold**
***bold and italic***
~~strikethrough~~

Lists

  • Headers in Markdown Syntax:

Unordered List

  • Unordered List in Markdown Syntax
mdarticle.md
Copy code
- Item 1
- Item 2
  - Subitem 1
  - Subitem 2

Ordered List

  • Ordered List in Markdown Syntax
mdarticle.md
Copy code
1. First item
2. Second item
   1. Subitem 1
   2. Subitem 2

  • Links in Markdown Syntax:
mdarticle.md
Copy code
[Link Test](http://serverx.org.in/)

Images

  • Images in Markdown Syntax:

  • For online links:

mdaticle.md
Copy code
![Link text](https://jsd.012700.xyz/gh/jerryc127/CDN/img/Markdown-Style-test-cover.png)
  • For local images:
mdFile Structure
Copy code
- articles
  └── markdown-syntax-guide
       ├── img
       │    ├── featured.png
       │    └── sample.png
       └── index.md
mdarticle.md
Copy code
![sample Image](sample.png)

Blockquotes

  • Blockquotes in Markdown Syntax:
mdarticle.md
Copy code
> This is a blockquote

Code Snippets

  • Code Snippets in Markdown Syntax:

For SERVER X 101 articles, remove those spaces infront of ``` for making it work

mdarticle.md
Copy code
```py
code block
```

Horizontal Rule

  • Horizontal Rule in Markdown Syntax:
mdarticle.md
Copy code
---

Tables

  • Tables in Markdown Syntax:
mdarticle.md
Copy code
| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |

Task Lists

  • HeadTask Listsers in Markdown Syntax:
mdarticle.md
Copy code
- [x] Task 1
- [ ] Task 2
Explore Related Topics
Wanna Discover more Interesting Topics?
nextjs
Dec 21, 2024

Next.js (Pages Router) and Contentlayer Setup

In this blog we will look how to setup Next.js and Contentlayer for an Blog page. Step one Install necessary deps bash npm install \ contentlayer nextcontentlayer \ shiki rehypeshiki rehypeprettycode \ rehypeautolinkheadings rehypeslug rehyperewrite rehypestringify \ remarkgfm unified \ datefns readingtime create contentlayer.config.ts file add contentlayer.config.ts in your root of the project and you have to create your blog files in this folder folder strcture of the necessary files and folders bash /public /content /blog /markdownsyntaxguide index.mdx contentlayer.config.ts tsconfig.json nextjs.config.ts ts import { defineDocumentType, ma
nextjs
Dec 21, 2024

Next.js (Pages Router) and Contentlayer Setup

Building a Scalable MDX Blog with Next.js and Contentlayer As engineering leads, one of our recurring challenges is balancing scalability, readability, and extensibility when building contentheavy frontend applications. A lightweight, composable blog system using Next.js (Pages Router) and Contentlayer checks all the right boxes—type safety, statically generated performance, and full MDX control. In this post, you'll set up a productiongrade foundation for a statically rendered blog using Contentlayer and Next.js, with an emphasis on correctness, longterm maintainability, and modern DX. Project Structure Here’s the minimal directory layout yo
powershell
May 5, 2023

Configuring PowerShell (shell prompt)

In Windows PowerShell, customizing your shell prompt can enhance your development environment by providing valuable information at a glance. This guide walks you through configuring Windows PowerShell to display a customized prompt with the username, date, and current folder name. Checking for Existing Profile STEP 1: Before proceeding, check if you have an existing profile set up in PowerShell: powershell testpath $profile STEP 2: If the result is false, create a new profile: powershell newitem path $profile itemtype file force STEP 3: Now, open the profile in Notepad: powershell notepad $profile STEP 4: Paste the following function to displ