Open Source for Beginners
Starting Your Open Source Project
Demo 3 Markdown
Learn how to use Markdown, a lightweight markup language ideal for writing documentation, READMEs, and blog posts. Write plain text and see it rendered in real time across GitHub, GitLab, and other platforms.
Why Use Markdown
Markdown is widely supported and easy to learn. It helps you create well-structured documentation with minimal effort.
Note
Markdown works seamlessly on GitHub, GitLab, Bitbucket, and most static site generators like Jekyll or Hugo.
Headings
Use one to six hash symbols (#
) at the start of a line to create headings:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Text and Line Breaks
Write paragraphs by separating text with blank lines. To force a line break within a paragraph, end a line with two spaces:
This is a paragraph describing how Markdown
handles line breaks.
This is another paragraph.
Emphasis and Lists
You can emphasize text and create different kinds of lists:
Emphasis Types
Style | Syntax | Rendered Output |
---|---|---|
Bold | **bold text** | bold text |
Italic | *italic text* | italic text |
Bold + Italic | ***bold italic*** | bold italic |
Unordered Lists
Start lines with -
, *
, or +
:
- Item 1
- Item 2
- Nested item
Ordered Lists
Use numbers followed by a period:
1. First item
2. Second item
Task Lists (Checkboxes)
Great for tracking progress:
- [ ] Task not completed
- [x] Task completed
Code Formatting
Inline Code
Wrap code snippets in single backticks:
Use inline code
to highlight commands or file names.
Code Blocks
Fenced code blocks support syntax highlighting. Specify the language after the opening backticks:
Note
Always include the language identifier (e.g., javascript
, python
) for better readability.
console.log("Hello, world!");
print("Hello, world!")
Links and Blockquotes
Links
Create hyperlinks with the format [link text](URL)
:
[Visit GitHub](https://github.com)
Blockquotes
Use the greater-than sign (>
) for quotations:
> This is a blockquote.
> It can span multiple lines.
Now that you’ve mastered Markdown basics, you’re ready to write clear, SEO-friendly documentation for your projects.
Links and References
Watch Video
Watch video content