Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pradipchaudhary/markdown-1hr-guide

This repository contains a concise, yet comprehensive guide to mastering Markdown in just one hour. Whether you're a beginner looking to get started or an experienced developer needing a quick reference, this ebook covers all the essentials and some advanced features of Markdown.
https://github.com/pradipchaudhary/markdown-1hr-guide

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/pradipchaudhary/markdown-1hr-guide
Owner: pradipchaudhary
Created: 2024-08-29T07:09:17.000Z (3 months ago)
Default Branch: master
Last Pushed: 2024-08-29T17:16:58.000Z (3 months ago)
Last Synced: 2024-08-30T08:41:49.740Z (3 months ago)
Language: HTML
Size: 12.7 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Markdown 1-Hour Guide

## Overview
This repository contains a concise, yet comprehensive guide to mastering Markdown in just one hour. Whether you're a beginner looking to get started or an experienced developer needing a quick reference, this ebook covers all the essentials and some advanced features of Markdown.

## Contents
- **Introduction**: Overview and importance of Markdown.
- **Chapter 1: Markdown Basics**: Headings, paragraphs, line breaks, emphasis, and blockquotes.
- **Chapter 2: Lists and Links**: Creating ordered and unordered lists, nested lists, and adding links.
- **Chapter 3: Images and Code**: Embedding images, inline code, code blocks, and syntax highlighting.
- **Chapter 4: Tables and Special Characters**: Creating tables, aligning text, and escaping special characters.
- **Chapter 5: Advanced Features**: Footnotes, task lists, strikethrough, horizontal rules, and custom HTML.
- **Conclusion**: Recap of key concepts, resources for further learning, and practice exercises.

#### Introduction
- Overview of Markdown.
- Importance of Markdown in modern documentation and content creation.
- Quick setup (text editor, Markdown preview).

#### Chapter 1: Markdown Basics (10 Minutes)

- **Topics to Cover:**
- Headings
- Paragraphs
- Line Breaks
- Emphasis (Bold, Italics)
- Blockquotes

- **Explanation and Examples:**

##### Headings
Markdown uses `#` for headings. The number of `#` symbols determines the heading level.

**Example:**
```markdown
# Heading 1
## Heading 2
### Heading 3
```

##### Paragraphs and Line Breaks
Simply write text to create paragraphs. Use two spaces at the end of a line to create a line break.

**Example:**
```markdown
This is a paragraph.

This is another paragraph with a
line break.
```

##### Emphasis
Use `*` or `_` for italics and `**` or `__` for bold text.

**Example:**
```markdown
*Italic* or _Italic_

**Bold** or __Bold__
```

##### Blockquotes
Use `>` to create blockquotes.

**Example:**
```markdown
> This is a blockquote.
```

#### Chapter 2: Lists and Links (10 Minutes)

- **Topics to Cover:**
- Ordered Lists
- Unordered Lists
- Nested Lists
- Links (Inline and Reference)

- **Explanation and Examples:**

##### Ordered Lists
Use numbers followed by a period to create ordered lists.

**Example:**
```markdown
1. First item
2. Second item
3. Third item
```

##### Unordered Lists
Use `-`, `*`, or `+` to create unordered lists.

**Example:**
```markdown
- Item 1
- Item 2
- Item 3
```

##### Nested Lists
Indent lines to create nested lists.

**Example:**
```markdown
1. First item
- Sub-item 1
- Sub-item 2
2. Second item
```

##### Links
Create links using `[link text](URL)`.

**Example:**
```markdown
[OpenAI](https://www.openai.com)
```

For reference links:
```markdown
[OpenAI][1]

[1]: https://www.openai.com
```

#### Chapter 3: Images and Code (10 Minutes)

- **Topics to Cover:**
- Images
- Inline Code
- Code Blocks
- Syntax Highlighting

- **Explanation and Examples:**

##### Images
Add images using `![alt text](image URL)`.

**Example:**
```markdown
![Markdown Logo](https://markdown-here.com/img/icon256.png)
```

##### Inline Code
Use backticks `` ` `` to add inline code.

**Example:**
```markdown
Use `code` for inline code.
```

##### Code Blocks
Use triple backticks for code blocks.

**Example:**
```markdown
```javascript
console.log("Hello, Markdown!");
```
```

##### Syntax Highlighting
Specify the language after the triple backticks for syntax highlighting.

**Example:**
```markdown
```python
def greet():
print("Hello, Markdown!")
```
```

#### Chapter 4: Tables and Special Characters (10 Minutes)

- **Topics to Cover:**
- Creating Tables
- Aligning Text in Tables
- Escaping Special Characters

- **Explanation and Examples:**

##### Creating Tables
Use pipes `|` and hyphens `-` to create tables.

**Example:**
```markdown
| Header 1 | Header 2 |
| -------- | -------- |
| Row 1 Col 1 | Row 1 Col 2 |
| Row 2 Col 1 | Row 2 Col 2 |
```

##### Aligning Text in Tables
Use colons `:` to align text in tables.

**Example:**
```markdown
| Left Align | Center Align | Right Align |
| :--------- | :----------: | ----------: |
| Left | Center | Right |
```

##### Escaping Special Characters
Use backslashes `\` to escape special characters.

**Example:**
```markdown
\*This is not italic\*
```

#### Chapter 5: Advanced Features (10 Minutes)

- **Topics to Cover:**
- Footnotes
- Task Lists
- Strikethrough
- Horizontal Rules
- Custom HTML

- **Explanation and Examples:**

##### Footnotes
Use `[^1]` to create footnotes.

**Example:**
```markdown
This is a footnote reference[^1].

[^1]: This is the footnote text.
```

##### Task Lists
Create task lists using `- [ ]` for incomplete and `- [x]` for completed tasks.

**Example:**
```markdown
- [ ] Task 1
- [x] Task 2 (completed)
```

##### Strikethrough
Use `~~` to create strikethrough text.

**Example:**
```markdown
~~This is strikethrough~~
```

##### Horizontal Rules
Create horizontal rules using three or more hyphens `---`.

**Example:**
```markdown
---
```

##### Custom HTML
Insert custom HTML within Markdown.

**Example:**
```markdown

Click to expand

Hidden content

```

#### Conclusion (10 Minutes)

- **Topics to Cover:**
- Recap of key concepts.
- Resources for further learning.
- Practice exercises.

- **Explanation:**

A summary of the key concepts covered in the ebook, with links to further resources like [Markdown Guide](https://www.markdownguide.org) and practice exercises to solidify the learning.