“Markdown” is two things: (1) a plain text formatting syntax; and (2) a software tool, written in Perl, that converts the plain text formatting to HTML. -Markdown This module focuses on the formatting side of Markdown. Markdown formatting is widely supported by and used in a wide variety of fields and tools including GitHub project documentation.
Markdown is best learned by simply writing a markdown file (like a README.md) or editing an existing markdown file.
Since you are most likely going to use GitHub (or a similar service) for you first markdown file, get started by reading these documents:
Services sometimes add extras to default Markdown. An example would be GitHub, which uses 'GitHub Flavored Markdown' or GFM.
Keep an eye out for useful extras, but be sure to use them wisely if you want to use the same markdown file on different services.
Markdown is easily practised by adding a simple README.md to every (programming) project you work on, explaining what the project does, is about, and/or how the project is used.
To quickly get used to conventions and learn how to structure your README and other markdown documents, have a look at other projects' README files. You can learn a lot by simply having a look at a README like this one.
Once you have worked with a lot of documentation, you will develop your own taste of what you like or not like in documentation. This also applies to how you prefer your documentation to be structured.
Copyright 2018 Opensource Academy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.