You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

7.4 KiB

Raw Blame History

Complete Guide to Writing Markdown (.md) Files

1. Headers

Use the # symbol to create headers. More # symbols = smaller headers:

# Heading 1 (Main Title)
## Heading 2 (Section)
### Heading 3 (Subsection)
#### Heading 4
##### Heading 5
###### Heading 6

2. Text Formatting

Bold Text

Use **text** or __text__:

This is bold
This is also bold

Italic Text

Use *text* or _text_:

This is italic
This is also italic

Bold and Italic

Use ***text*** or ___text___:

This is bold and italic

Strikethrough

Use ~~text~~:

~~This text is crossed out~~

3. Lists

Unordered Lists

Use -, *, or +:

- Item 1
- Item 2
  - Nested item 2.1
  - Nested item 2.2
- Item 3

Ordered Lists

Use numbers followed by a period:

1. First item
2. Second item
   1. Nested item 2.1
   2. Nested item 2.2
3. Third item

4. Links and Images

Hyperlinks

[Display Text](URL)

Example: Visit Google

Links with Titles

[Display Text](URL "Title")

Example: Visit Google

Images

![Alt Text](Image URL)

Example:

5. Code

Inline Code

Use backticks ` for inline code:

Example: Use the print() function to display text.

Code Blocks

Use three backticks ``` and specify the language:

def hello_world():
    print("Hello, World!")
    return True

function helloWorld() {
    console.log("Hello, World!");
    return true;
}

6. Blockquotes

Use the > symbol:

> This is a blockquote.
> It can span multiple lines.
>> Nested blockquote

Renders as:

This is a blockquote. It can span multiple lines.

7. Horizontal Lines

Use ---, ***, or ___:

---

8. Tables

Use pipes | to create tables:

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Header 1	Header 2	Header 3
Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6

9. Escape Characters

Use backslash \ to escape special characters:

\* This won't be a bullet point
\# This won't be a header

10. Special Elements

Task Lists

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

Line Breaks

Use two spaces at the end of a line or press Enter twice for a paragraph break.

11. Best Practices for Article Writing

Use clear hierarchy - Organize your content with proper heading levels
Keep paragraphs short - Easier to read on screens
Use lists - Break down complex information
Add visual breaks - Use horizontal lines to separate sections
Include code examples - If your article mentions code, show examples
Link to references - Provide sources and related content
Use emphasis wisely - Bold and italic for important terms only
Consistent formatting - Keep the same style throughout
Proofread - Check for typos and grammar
Test links - Make sure all links work

12. Article Structure Template

Use this template for your article:

# Article Title

## Abstract or Introduction
Brief overview of what the article covers.

## 1. First Main Topic
Content here...

### 1.1 Subtopic
More detailed content...

## 2. Second Main Topic
Content here...

## 3. Third Main Topic
Content here...

## Conclusion
Summary and key takeaways...

## References
- [Source 1](URL)
- [Source 2](URL)

13. Mathematical Equations (LaTeX)

Markdown supports LaTeX syntax for mathematical equations. Perfect for scientific and technical articles!

Inline Equations

Use single dollar signs $...$ to write equations within text:

The famous equation $E = mc^2$ describes energy and mass.

Renders as: The famous equation E = mc^2 describes energy and mass.

Display Equations (Centered)

Use double dollar signs $$...$$ for larger, centered equations:

$$E = mc^2$$

Renders as:

E = mc^2

Greek Letters

$$\alpha, \beta, \gamma, \delta, \epsilon, \pi, \sigma, \omega$$

Fractions

$$\frac{numerator}{denominator}$$

Example: $$\frac{a + b}{c}$$

Superscript and Subscript

$$x^2 + y_1 = z$$
$$a^{2n} + b_{i,j}$$

Square Roots

$$\sqrt{x}$$
$$\sqrt[n]{x}$$

Summation and Products

$$\sum_{i=1}^{n} x_i$$

$$\prod_{i=1}^{n} x_i$$

Integrals

$$\int_0^{\infty} e^{-x} dx$$

$$\int \int_R f(x,y) dA$$

Advanced Examples

Quadratic Formula:

$$x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$$

Binomial Expansion:

$$(a + b)^n = \sum_{k=0}^{n} \binom{n}{k} a^{n-k} b^k$$

System of Equations:

$$\begin{cases}
x + y = 5 \\
x - y = 1
\end{cases}$$

Matrix:

$$\begin{pmatrix}
a & b \\
c & d
\end{pmatrix}$$

14. Equation References and Numbering

You can create numbered equations and reference them throughout your document. This is essential for academic and technical papers.

Method 1: Using Equation Environment with Labels

$$
\begin{equation}
E = mc^2
\label{eq:einstein}
\end{equation}
$$

As shown in equation \eqref{eq:einstein}, energy equals mass times...

This creates a numbered equation that you can reference later using \eqref{eq:einstein}.

Method 2: Align Environment (Multiple Equations)

$$
\begin{align}
x + y &= 5 \label{eq:first} \\
x - y &= 1 \label{eq:second}
\end{align}
$$

From equation \eqref{eq:first} and equation \eqref{eq:second}, we can solve for $x$ and $y$.

Method 3: Step-by-Step Derivation

$$
\begin{align}
(a + b)^2 &= a^2 + 2ab + b^2 \label{eq:expand} \\
&= a^2 + ab + ab + b^2 \\
&= a(a + b) + b(a + b)
\end{align}
$$

Equation \eqref{eq:expand} shows the binomial expansion.

Referencing Equations

Once you've labeled an equation, reference it using:

\eqref{eq:label} - Shows as: (1), (2), etc.
\ref{eq:label} - Shows just the number without parentheses

Naming Conventions for Labels

Use descriptive label names:

\label{eq:einstein} - Named after scientist
\label{eq:pythagoras} - For Pythagorean theorem
\label{eq:quadratic_formula} - Descriptive name
\label{eq:1} - Simple numbering (less recommended)

Complete Example for Your Article

## Physics Section

The most important equation in physics is:

$$
\begin{equation}
E = mc^2
\label{eq:mass_energy}
\end{equation}
$$

As Einstein demonstrated in equation \eqref{eq:mass_energy}, 
the energy of an object is equal to its mass multiplied by the 
square of the speed of light.

## Results

Equation \eqref{eq:mass_energy} has been experimentally confirmed...

Tips

Use descriptive labels - Makes it easier to find references later
Place labels at the end of equations - \label{} should be last
Use consistent naming - eq:, fig:, table: prefixes help organize
Test references - Make sure all \eqref{} calls match existing labels
Not all markdown viewers support this - Works best in LaTeX, Jupyter, and some markdown processors

Getting Started

Create your .md file in any text editor
Use the syntax above to format your content
Save the file with the .md extension
You can preview it in VS Code or any markdown viewer

Happy writing! 📝

7.4 KiB Raw Blame History