We write blog using ventilated prose style. For example, for the Author information in jekyll blog, we wrote it as given below. In the sample shown below, we have removed all code examples since we want to show how sentences are written and not code.
1--- 2layout: post 3title: Author information in jekyll blog 4categories: [ruby] 5author_github: neerajdotname 6canonicalUrl: https://bigbinary.com/how-we-work/ventilated-prose-for-writing-blog 7--- 8 9BigBinary's 10[blog](http://blog.bigbinary.com) 11is powered by 12[jekyll](http://jekyllrb.com). 13In every blog we display author's name, 14author's twitter handle, 15author's github id 16and 17author's avatar. 18In this blog 19I'm going to discuss 20how we collect all that information 21in a simple manner. 22 23We create a directory called ___data__ 24in the root folder. 25This directory has a single file called __authors.yml__ 26which in our case looks like this. 27 28We do not need 29to do anything to load __authors.yml__ . 30It is automatically loaded 31by jekyll. 32 33When we create a blog 34then the top of the blog looks like this. 35 36Notice the last line 37where we have put in the author's github id. 38That's the identifier we use 39to pull in author's information. 40 41In order to display author's name 42we have following code 43in the layout. 44 45Similary to display author's twitter handle 46and 47github id 48we have following code. 49 50Now the blog will display the author information 51and 52all this information 53is nicely centralized 54in one single file.
Here are some simple rules we follow.
- Put a link in its own line.
That line should have just the link and nothing else.
Always start a new sentence after line break.
Try to give and a line of its own.
The advantage is that anything can be added before and easily without changing the whole line.
- If there exists an article in any of the books with similar content as that of the blog, please add the url of the article as
canonicalUrlin the frontmatter of the blog content. This is for better SEO.
We are less concerned about where to break the sentences. We care more about not having long sentences.
This style of writing has helped us keep sentences short and meaningful.