This is a Meraki Post internal page, to help us with the common formatting guidelines, so as to ensure uniformity throughout the site. This page may not be relevant to you if you’re a visitor.
Posts on this site are made using this beautifully simple lightweight markup language called Markdown (I know, Markdown markup sounds funny). This is so that you can use any text editor, including the good old Notepad, to write posts.
Tools you need:
- Atom by GitHub to write posts in a beautiful interface.
- RIOT by Lucian Sabo to compress images for the posts so things load superfast.
- GitHub for Windows by GitHub to push content to GitHub.
- Every post you make is essentially a Markdown file, which looks like a text file.
- All posts must be placed in the folder,
- All drafts must be placed in the folder,
- All posts you place in the
_postsfolder should be named like
- All posts should have the following frontmatter in the beginning of the file (including the three hyphens).
- When naming files, omit non-catch words. For instance,
Alice in Wonderlandwould become,
alice-wonderland; this is called slugification.
- The date should be in
yyyy-mm-ddformat, such as
- The filename would be a combination of the date and the title, separated by a hyphen, along with its extension,
.md(for Markdown), such as
post, and only
- The title should be a full title, with proper capitalisation.
- The subtitle should be the full name of the author, appropirately capitalised.
authorattribute here is for the author of the post, which is you. Write your first name, all in lowercase, such as,
- Tags are important. Make sure you leave the
tags:line empty, and list down the tags preceded by a hyphen and a space. Tags can have spaces. So, it’s OK to have a tag like
- Image is important, too. It is typically the image of the book cover. Compress the image, and store it under
\assets\postimagesas a JPG file. Add the link to that image here, replacing
/. Windows understands
\, Jekyll understands
- Most importantly, don’t forget to enclose this content between two lines of three hyphens (
Here’s a complete sample to help you understand. Note that there’s no
by before the name of the author.
Formatting the posts
Formatting content is very easy with Markdown. Here are the different formats we have:
- Just type on, like you would on Word. Make sure you don’t make spelling or grammatical errors.
- Leave a blank line after the frontmatter.
- Leave a blank line after every paragraph.
Here’s an example:
Notice the blank line after the frontmatter, and between the two paragraphs.
Poem verses require line breaks, and not paragraph breaks, when splitting lines. To achieve this, put a double
\, at the end of each line you need a line break at, like so:
Remember not to add the
\\ markup at the end of the last line of the stanza.
Compressing the image is important.
Just copy-paste the following code. Liquid will take care of putting up the image, as long as you’ve specified the image in the frontmatter.
Subheadings are specified using
#. A first-level subheading is written as
# First Level Heading. A second-level subheading is written with two hashes, like
## Second Level Heading. The number of hashes denote the level.
The subheadings in our posts are all third level.
Also, ensure that there’s a blank line before and after the subheading. Here’s an example.
Block quotes are your favourite formatting control from the Blogger Editor and Open Live Writer. This is used to produce formatting just how it is at the beginning of this page. In Markdown, it is very simple. Just precede the text with
>. A space after
> is optional. However, to make the style consistent, you may want to add a space after the
>. Technically, that will have no effect on formatting whatsoever.
What you need to remember here is that if you want to separate block quotes, you need to leave an empty line between the block quotes that you want separated.
Emphasis usually is shown using italics in books. It is more about the kind of font we’re using. We use a serif font, called Crimson. In this case, it is good to use italics, since this font has real italics, and they’re distinct from the roman (normal) style.
To emphasise any text, wrap it between two
_, just how we do it on WhatsApp. Here’s an example. Here, ‘at least’ will be italicised.
Other important entities
All our content is HTML. When putting up content, especially since we’re all about literature, a style guide is important. It shows that we care about quality.
Open Live Writer used to take care of those little things like an em-dash and all, when you typed. It wouldn’t be the case here. We need to take a small step to ensure things are as we need them to be. It’s absolutely possible, no worries.
Please follow the guidelines listed below to ensure we maintain our reputation with respect to quality:
- Use hyphens to spell multipart words, such as, hither-thither. Use a hyphen with phrasal adjectives as well, such as high-end machinery. Writing a hyphen is as simple as typing the
-key on the keyboard.
- Use an en dash to show ranges, or when connecting pairs of words, such as 1939–1945, or The India–Pakistan relationship. An en dash is written using a pair of hyphens, like
- Use an em dash to give a nice break to the sentence you’re writing, such as Today, book typography is conveniently—and blatantly—ignored. This is done using three hyphens, like,
Today, book typography is conveniently---and blatantly---ignored.
- When you want the ellipsis (…), just type three dots
.... Markdown will convert it to an ellipsis character.
- Non-breaking spaces are important. These ensure that things like Dr Jekyll and 25 km don’t split—that’s because Dr at the end of a line and Jekyll on the next line would make no sense. You’d need to insert a non-breaking space to ensure this doesn’t happen. Enter a non-breaking space with an HTML entity,
. The ampersand and the semicolon are very important. An example would be,
Mr Singh. Also note that a non-breaking space itself is a space, so don’t add an additional space before or after the entity. It’ll simply kill its purpose.
Our site has to hardly use a list—a bulleted or numbered. However, if we do, here’s how we’d do it:
Notice the blank lines before and after the list. It is important. The list would not be rendered properly if the blank line is ignored.
Tab key on your keyboard for indentation. You could also add a couple of spaces before the hyphen for indentation. Markdown can understand that.
Hyperlinks are simple. Enclose the text to show on the page in square brackets,
[like so], and enter the link in parentheses, like
Visit [Meraki Post](www.merakipost.com) for more exciting content!, to get Visit Meraki Post for more exciting content!
Supercharge your writing
markdown-writer for Atom. Our GitHub project has some customization done, to bring in some level of automation.
Ctrl + Shift + P and start typing
Markdown Writer: Create Default Keymaps. The results will filter as you type. Just select
Markdown Writer: Create Default Keymaps here. A new file will open with a bunch of code. Just save the file and close it. Your default keybindings have been created.
To create a new post, press the
Alt key and from the menu on top, select
Markdown Writer >
New post. Fill in the fields, and a good chunk of the boring task is already done! It will:
- Automatically create a post in the
- It will show the mandatory frontmatter form, which you can fill.
- Some of the content is already generated, such as the date and the slug.
Remember to change the date if you’re scheduling the post. Time is not necessary unless we’re making two posts in a day.
To add emphasis, or toggle heading style and all, refer the keybinding cheatsheet below. Select the text you want to apply formatting to, and hit the relevant combination:
||Toggle italic text|
||Toggle bold text|
This is not an exhaustive guide, but a good starting point. If you need assistance, you know where to find Ram!