A Guide to writing beautiful blogs, documentation and posts seamlessly

A list of resources to write various themed blog posts without getting your hands dirty.

This post shall contain links to learn, use and how to reference for further usage, both personally and to the public.

Why write?

Blogs are helpful to keep the world updated as to what you’re doing. Books are written to distribute knowledge such that people may make steadfast progress for humanity without reinventing the wheel each time.

Why write using any of these ?

Often, I’ve noticed that writing requires free thought flow whereas writing code requires a constructive thought flow. Programming, however requires an analytical thought flow.
Thought-flow disruption free Writing.

Problem:

Layout: I found that writing articles while composing HTML around it was quite time-intensive and frustrating. Writing plain articles seemed to lack flair and lustre that comes with layout and formatting, but writing code at the same time hinders your thinking process.

Version control is a life-saver for people like me that tend to forget more often what than why.

Portability is essential.
Writing your posts wrapped in tons of HTML is okay.
Writing your posts in JSON to import in Angular based blogs is a tad bit better.
Writing your posts in a format that can be used for creating PDFs, Epubs, HTML, rst and LaTeX with proper formatting and layout rendering is necessary.

Solution:
A portable standard with version control that allows you to export into PDFs, Epubs, HTML, rst and LaTeX and more without trouble.

Mode of Action:

Version Control: Github
Rendering: HTML via github pages
Portability: Sphinx written in .rst or markdown exports

Write your blogs, articles, books with git as your version control.
Use a private repository if needed.
Use either Jekyll or Sphinx with Readthedocs.io

“There is no greater agony than bearing an untold story inside you.”
- Maya Angelou

References:

1. Readthedocs.io
2. ReST syntax and Sphinx Cheatsheet
3. .rst convent
4. Trial Editor
5. Sphinx documentation
6. Sphinx introduction video
7. Jekyll Docs Post

I hope this post was helpful.

I’m Prahalad Belavadi and much of what I do can be found on Belavadi.com

Thank you.