https://github.com/heyfoz/readme-markdown-examples
Explore Markdown syntax with this README, offering examples of headings, emphasis, lists, links, and code blocks. Check out README.txt in the project directory for the Markdown used to create this demonstration.
https://github.com/heyfoz/readme-markdown-examples
documentation example github markdown readme
Last synced: 10 months ago
JSON representation
Explore Markdown syntax with this README, offering examples of headings, emphasis, lists, links, and code blocks. Check out README.txt in the project directory for the Markdown used to create this demonstration.
- Host: GitHub
- URL: https://github.com/heyfoz/readme-markdown-examples
- Owner: heyfoz
- License: mit
- Created: 2024-05-24T21:18:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-01T01:50:16.000Z (over 1 year ago)
- Last Synced: 2025-01-30T05:11:38.661Z (about 1 year ago)
- Topics: documentation, example, github, markdown, readme
- Homepage:
- Size: 1.85 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README Markdown Examples
This README provides a demonstration of Markdown syntax for common formatting.
## Image Styled Using HTML/Inline CSS
[README_cyber.png file](README_cyber.png)
## Heading
### Subheading
## Emphasis
*Italic text using \** or _Italic text using \__
**Bold text using \*\*** or __Bold text using \_\___
***Bold and italic text using \*\*\**** or ___Bold and italic text using \_\_\____
## Lists
### Unordered List
- Item 1
- Item 2
- Subitem 2.1
- Subitem 2.2
### Ordered List
1. First item
2. Second item
- Subitem
- Subitem
## Links
[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
[Getting started with writing and formatting on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
## Code
Inline `code` can be indicated with backticks. For code blocks:
```python
def greet():
print("Hello, world!")
```
The example Markdown text used to display this README is in [README.txt](README.txt) in the project directory.
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.