Marking Down my experience

This story is going to be my debut on Medium. Apologies in case you do not find a flow in my narration. I will try to improve on it surely.

I did not know the difference between a markup and a markdown language two years back and always wanted to design README files for my GitHub repositories just like so many others. But I always felt that it would be a time-consuming process that would involve learning commands, syntaxes, etc. This was my experience with other programming languages learnt till that moment. Those programming languages needed some familiarity and memorization of syntaxes before we could dive into code something complex. To my surprise, markdown coding was easier than I thought it was. It was more like doing latex coding where you keep trying out different things and based on the output you get, and you can make necessary changes. In this manner, I learnt how to refer to markdown cheatsheets created by some experienced coders on GitHub and use it according to the situation. Thanks to the Open Source community for making the learning process faster for beginners like me. The challenge was, how am I going to design the markdown files for my GitHub repositories? How creative can I get? How can I make use of the way I organize the repository to design the markdown and vice versa. Can I make it look like a book chapter or a website or just a simple text document? I didn’t have to go far to learn some ideas on designing markdown, thanks to some fantastic seniors and batchmates. They were already quite creative in my eyes when I saw their GitHub repositories and how they had learnt the art of explaining their project structure in their repositories. That gave me a boost to start writing my autobiography using markdown. I know who writes an autobiography using markdown :p. As I got more familiar to markdown, I started designing README files for my older GitHub repositories (ML and Android dev) which could be included in my resume.

About me

Today, I still feel I can add some more things to make them look attractive and informative. One of the satisfying feelings for me during this journey was getting familiar with python and markdown, which brings me to python notebooks. A python notebook is a tool which perfectly suits what Python language is at the core. The language is interpreted during the run time, which matches a notebook cell that divides a written code into many parts called cells and gives an idea of how the language can allow you to think smaller chunks can make up a code. One other thing which notebook allows is to add markdown cells. Since this feature was available, I started using the notebook as a tool to narrate my code to a person who doesn’t understand code snippets so easily. Although I don’t consider myself anywhere close to being called a story-teller, the way I design my Python notebook with markdown cells around the code snippets makes me feel that I am narrating something technical to someone.

README.md file of my GitHub project

So far, that has been my experience with markdown at three sources — GitHub README, autobiography, and python notebook. Let me know where all have you used markdown to explain your work and what has your experience been with this language if you consider it as one :p?

Medium has allowed me to channelize my thoughts and writing skills, which could make me think better and quicker. Thanks for reading my debut story. Have a nice day :)

A vegan who wants to end speciesism.