Getting started with documenting in Markdown & GitHub
2 minute read
I've been using GitHub repositories and markdown to document my work. It's really easy. Example: Turtlebots project
It's a markup language used for quick and simple documentation. This README uses markdown. Any file with the extension .md is a markdown file.
It's super simple! The site learnxinyminutes.com is an incredible resource many use to brush up on language syntax. Personally, I learned Markdown from existing READMEs across GitHub since it's really easy. I'm not smart, either.
No. I use Obsidian since it nicely writes and renders markdown.
Install Obsidian to edit markdown files. Using GitHub Desktop (recommended) or Git CLI, clone the repo of your choice that'll include your markdown files. In this case, I'll be using this repo as an example.
Upon opening Obsidian, open the cloned folder as a vault. Viola! Create a new file (defaults to Markdown) and start typing.
Basic GitHub stuff:
- When you start writing, pull from origin! This applies when you're working with others.
- When you're done writing, make a commit and push your changes!
And that's it! Not so hard, was it?