https://github.com/mattcone/markdown-guide

The comprehensive Markdown reference guide.
https://github.com/mattcone/markdown-guide

documentation documentation-tool markdown md

Last synced: 4 days ago
JSON representation

The comprehensive Markdown reference guide.

• Host: GitHub
• URL: https://github.com/mattcone/markdown-guide
• Owner: mattcone
• License: mit
• Created: 2017-01-31T20:45:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T18:59:26.000Z (3 months ago)
• Last Synced: 2024-12-25T18:02:43.805Z (18 days ago)
• Topics: documentation, documentation-tool, markdown, md
• Language: HTML
• Homepage: https://www.markdownguide.org
• Size: 83.3 MB
• Stars: 3,390
• Watchers: 82
• Forks: 632
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• project-awesome - mattcone/markdown-guide - The comprehensive Markdown reference guide. (HTML)
• awesome-starred - mattcone/markdown-guide - The comprehensive Markdown reference guide. (documentation)
• jimsghstars - mattcone/markdown-guide - The comprehensive Markdown reference guide. (HTML)

README

        
# Markdown Guide

[![Build Status](https://github.com/mattcone/markdown-guide/workflows/tests/badge.svg?branch=master)](https://github.com/mattcone/markdown-guide/actions)

*[The Markdown Guide](https://www.markdownguide.org)* is a comprehensive Markdown reference designed for both novices and experts. It was born out of frustration with existing Markdown references that are incomplete and inadequate.

## Contributing

Contributions are welcome. Feel free to open a pull request with changes.

### Running it Locally

It can be helpful to preview changes on your computer before opening a pull request. *The Markdown Guide* uses the [Jekyll static site generator](http://jekyllrb.com/). After forking or cloning the repository, perform the following steps to generate the site and preview it:

- Make sure you have ruby installed on your computer. See https://www.ruby-lang.org/en/downloads/

- `bundle install`

- `bundle exec jekyll serve`

- Point your browser at http://127.0.0.1:4000/

### Adding tools

See [this page](https://github.com/mattcone/markdown-guide/wiki/Markdown-tool-directory) for information about adding applications to the [Markdown tools directory](https://www.markdownguide.org/tools/).

## License

The content of this project itself is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](LICENSE.txt).