Self-Indulgent Code: Why you should be using Markdown

Self-Indulgent Code: Why you should be using Markdown
http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/digg_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/reddit_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/dzone_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/stumbleupon_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/delicious_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/blogmarks_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/newsvine_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/google_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/myspace_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/facebook_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/yahoobuzz_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/sphinn_16.png http://www.nurelm.com/themanual/wp-content/plugins/sociofluid/images/twitter_16.png

 

If you are not aware of it, HTML can be a bit heavy for everyday markup. There is a good reason that huge sites like Wikipedia rely on wiki markup even though there is definitely a learning curve to be an expert at it. Well markdown sits politely in the middle. http://daringfireball.net/projects/markdown/

I decided to learn markdown because I worship at the alter of GitHub. This drew me into the habit of just writing all my documentation in markdown. Why not write an easily readable format that is just as good before or after being processed by Markdown.

Here is a sample:

#Responsive Tester
- This only works in webkit browsers
- Using HTML5 iframe sandbox this can display a page an respond with the correct CSS3 media selector queries
- This is a single file implementation responsive.html
- Based upon Matt Kersley Responsive Web Tester https://github.com/mattkersley/Responsive-Design-Testing
- [Demo](http://ninjapanzer.github.com/ResponsiveWebTester/ "Demo") of current build
equals

Responsive Tester

  • This only works in webkit browsers
  • Using HTML5 iframe sandbox this can display a page an respond with the correct CSS3 media selector queries
  • This is a single file implementation responsive.html
  • Based upon Matt Kersley Responsive Web Tester https://github.com/mattkersley/Responsive-Design-Testing
  • Demo of current build

I know this is simple but it is elegant. I know I am likely preaching to the choir at this point, but I hope you do try it out for yourself especially if you are working with the web.

Here is my digression about markdown. Modern websites can be very complex, leaving the content lost in a sea of tags. Since I have adopted markdown as my documentation syntax I have found that I generally design everything simpler. I don’t need round corners to help me read text I just need clean and well defined regions of text. I am a programmer at NuRelm and I have spent decades training my brain to seek out indentation. If anything, the thing that markdown should inspire in the general web is a concept of a regular indentation structure that helps us non-designers provide accessible content for the masses.

About the Author

Software Engineer and Code Enthusiast. I often shout, "For you, Object Oriented Programming was something that happened to other people". I am a web programmer by trade but I dable in machine learning through text analysis. (Wub Wub) @PaulSCoder

Author Profile: