This repository was archived by the owner on Jul 1, 2024. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork 143
Style Guide
Vadim Makeev edited this page Apr 10, 2014 · 10 revisions
Dev.Opera uses “kramdown” markdown engine with some additional features:
Entry title should be quoted by single quotes in following cases:
- If title contains
:, for exampletitle: 'Flexbox: Introduction' - If title starts from backtick, fox example:
title: '`getUserMedia` FTW'
If there’s already single quote in title It's Amazing! replace it with apostrophe 'It’s Amazing!' Alt Shift ] or quote it by double quotes: "It's Amazing!". Apostrophe is preferable of course.
Given title:
The W3C device orientation API: detecting orientation and acceleration Bad URL:
the-w3c-device-orientation-api-detecting-orientation-and-acceleration Good URL:
w3c-device-orientation Every header on a page will get id generated from its content:
# W3C device orientation API … <h1 id="w3c-device-orientation-api">W3C device orientation API</h1> It's good enough for simple headers like “Read more” or “Introduction”, but if your header contains more than 3-5 words and you're going to use it, it's better to specify custom id by adding {#id}:
# W3C device orientation API {#w3c-api} … <h1 id="w3c-api">W3C device orientation API</h1> Lorem `<html>` ipsum→ <html> ····<html><figure id="listing-1"> <div markdown="block"> <sample> </div> <figcaption markdown="span">Listing 1: Code `sample`</figcaption> </figure>> First paragraph > > Second paragraph, same quoteNot decided yet.
{% include figure.html path=page.id caption='caption' pictures=' src:picture.png; size:quarter; alt:text; link:url| ' %}