Markdown Guide
The Markdown Guide is a comprehensive Markdown reference designed for novice and intermediate users. It was born out of frustration with existing Markdown references that are incomplete, inadequate, or both.
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. 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 installbundle exec jekyll serve- Point your browser at http://127.0.0.1:4000/
Deployment
Pull requests merged to the master branch are automatically deployed to the production website.
License
The content of this project itself is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying source code used to format and display that content is licensed under the MIT license.