Skip to content

Add 5-paragraph summary of the repository content. #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markbpryan wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add 5-paragraph summary of the repository content. #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
![Markdown Guide book cover](cover.png)
"The Markdown Guide" is a comprehensive reference manual dedicated to the Markdown markup language. This repository houses the source material for the book, providing users with a complete guide to understanding and utilizing Markdown effectively.

This is the source repository for *The Markdown Guide* book. You can purchase the book on [Gumroad](https://gum.co/markdownguide), [LeanPub](https://leanpub.com/themarkdownguide), or [Amazon](https://www.amazon.com/dp/B07G7JB641).
The initial chapters of the book introduce readers to the fundamentals of Markdown. These chapters explain what Markdown is, highlighting its benefits such as portability, platform independence, and future-proofing. Readers will learn how Markdown works by converting plain text to HTML, and will be introduced to the concept of Markdown flavors. Chapter 2 further explores the diverse applications of Markdown, demonstrating its use in creating websites, documents, notes, books, presentations, and email messages.

## Contributing
Chapter 3 delves into the basic syntax elements of Markdown, providing a solid foundation for users. This includes comprehensive coverage of headings, paragraphs, line breaks, emphasis (bold and italic), blockquotes, ordered and unordered lists, inline code, horizontal rules, links, and images. The book also offers valuable guidance on character escaping and the incorporation of HTML to extend Markdown's capabilities.

Your contributions are welcome. Feel free to create issues and open pull requests. I use [Leanpub](https://leanpub.com/) to publish the book. If you have questions about the syntax, please refer to [their manual](https://leanpub.com/help/manual).
Building upon the basics, Chapter 4 explores extended Markdown syntax elements that offer more advanced formatting options. Key features covered include tables, fenced code blocks with syntax highlighting, footnotes, heading IDs, definition lists, strikethrough, task lists, emoji support, and automatic URL linking. It is important to note that the availability of these extended features can vary depending on the Markdown processor being used.

## License

The content of this project is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/).
To further support users, Chapter 5 provides a handy cheat sheet for quick reference to Markdown syntax. Ultimately, "The Markdown Guide" stands as a thorough resource, catering to both beginners seeking to learn the basics and experienced users aiming to master the full potential of Markdown for their various projects.
9 changes: 9 additions & 0 deletions SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
"The Markdown Guide" is a comprehensive guide to the Markdown markup language. This repository contains the source material for the book, offering a complete resource for understanding and utilizing Markdown effectively.

The initial chapters ease readers into Markdown, explaining what it is and its key benefits like portability, platform independence, and future-proofing. It covers how Markdown converts plain text to HTML and introduces the concept of different Markdown flavors. Chapter 2 then showcases the versatility of Markdown, detailing its applications in creating websites, documents, notes, books, presentations, and email messages.

Chapter 3 meticulously covers the basic syntax elements, establishing a solid foundation for users. It details headings, paragraphs, line breaks, emphasis (bold and italic), blockquotes, ordered and unordered lists, inline code, horizontal rules, links, and images. The chapter also provides essential guidance on escaping special characters and incorporating HTML to enhance Markdown documents.

Advancing from the fundamentals, Chapter 4 introduces extended syntax elements for more sophisticated document formatting. This chapter explains tables, fenced code blocks with syntax highlighting, footnotes, custom heading IDs, definition lists, strikethrough, task lists, emoji integration, and automatic URL linking. A key takeaway is that the availability of these extended features can differ between Markdown processors.

To consolidate learning, Chapter 5 offers a convenient cheat sheet for quick reference to all syntax elements. "The Markdown Guide" thus serves as an essential resource for anyone looking to learn Markdown from scratch or for experienced users wishing to master its full capabilities for diverse writing projects.