Basic Markdown Formatting Guide
Markdown is a straightforward way to format plain text that gets converted into correctly styled HTML on your website. You'll use these rules to write the main content in your .mdx files. Here are the most common formatting options:
Headings
Use the hash symbol (#) followed by a space to create headings. More hashes mean a smaller heading level. Headings help structure your document.
# Heading Level 1 (Largest, usually only one per page)
## Heading Level 2 (For major sections)
### Heading Level 3 (For sub-sections)
#### Heading Level 4
##### Heading Level 5
###### Heading Level 6 (Smallest)
`
Paragraphs
Just write text normally. Separate paragraphs with a blank line. Don't indent paragraphs.
This is the first paragraph. Write naturally.
This is the second paragraph. Make sure there's an empty line separating it from the one above.
Text Emphasis
- Bold: Use two asterisks (
**) or two underscores (__) around the text.
This text is **bold**.
This text is __also bold__.
- Italics: Use one asterisk (
*) or one underscore (_) around the text.
This text is *italic*.
This text is _also italic_.
- Bold and Italic: Use three asterisks (
***) or three underscores (___) around the text.
This text is ***bold and italic***.
This text is ___also bold and italic___.
Lists
Unordered Lists (Bullets)
Start each line with an asterisk (*), hyphen (-), or plus sign (+), followed by a space.
* Item 1
* Item 2
* Sub-item 2a (indent with two or four spaces)
* Sub-item 2b
- Another item A
- Another item B
+ Yet another item X
+ Yet another item Y
Ordered Lists (Numbers)
Start each line with a number followed by a period (.) and a space. Markdown automatically numbers them correctly, so you can even use 1. for every item if you prefer.
1. First item
2. Second item
3. Third item
1. Sub-item 3a (indent with spaces)
2. Sub-item 3b
1. Another first item (will render as 1.)
1. Another second item (will render as 2.)
Links
Create links using square brackets [] for the clickable text, immediately followed by parentheses () containing the URL (web address).
Visit [Google](https://www.google.com).
You can also use [relative links](/about-us) to link to other pages on your *own* site.
[Check out our features](/features).
Images
Images are similar to links but start with an exclamation mark !. The text in the square brackets [] is the "alternative text" or "alt text". This text describes the image and is very important for screen readers (accessibility) and SEO. It's shown if the image fails to load.
Note: Use relative paths starting with / (like /images/logo.png) for images stored within your website project. In PageRush content, leave the alt text blank () unless you specifically want to set it.
Blockquotes
Use the greater-than symbol (>) followed by a space at the beginning of a line to create an indented blockquote. This is often used for quoting text from another source.
> This is a blockquote. It stands out from the regular text.
> - Author Name (Optional attribution)
> You can have multiple paragraphs inside a blockquote.
> Just start each new paragraph line with `>`.
Horizontal Rule
Create a horizontal dividing line using three or more hyphens (---), asterisks (***), or underscores (___) on a line by themselves. Make sure there are blank lines above and below it.
Some text above the line.
---
Some text below the line.
***
Another divider.
Inline Code
Use single backticks (`) around text to show it as inline code. This is useful for mentioning variable names, file names, or short code snippets within a sentence.
To install dependencies, run `npm install` in your terminal.
The configuration is stored in the `.env` file.
Check the value of the `pageTitle` variable.
Note: For larger blocks of code (more than one line) or code that needs language-specific highlighting, use the standard triple backtick symbol above and below your code lines.
Compatible Markdown Features
PageRush uses specialized processing (remark and rehype) to provide additional features beyond basic Markdown:
- GitHub Flavored Markdown: Support for tables, task lists, and strikethrough text.
- Heading Slugs & Auto-links: All headings automatically get an ID (slug) so you can link directly to them.
- External Links: Links to other websites are automatically marked for safety. Use full
https://URLs for these. - Syntax Highlighting: Code blocks with a language tag (like ` ```javascript `) will be beautifully highlighted using Shiki.
- Sanitized HTML: For security, raw HTML tags or inline scripts are generally removed or restricted. Stick to Markdown and PageRush's custom components.
Updated on: 13/05/2026
Thank you!