User Tools

Site Tools


cross_platform:encoding:text-code:lightweight_markup

  

BBCode

or Bulletin Board Code is a lightweight markup language used to format posts in many message boards. The available tags are usually indicated by square brackets ([ ]) surrounding a keyword, and they are parsed by the message board system before being translated into a markup language that web browsers understand—usually HTML or XHTML.

- as used on Arch Linux's FluxBB.

Markdown

GitHub Flavored Markdown (GFM)

more natural line-breaks

https://help.github.com/articles/writing-on-github

For example, the final two verses of "Invictus" can be left like this:

Beyond this place of wrath and tears
Looms but the horror of the shade,
And yet the menace of the years
Finds, and shall find, me unafraid.

It matters not how strait the gate,
How charged with punishments the scroll,
I am the master of my fate:
I am the captain of my soul.

"markdown here" for email

http://markdown-here.com/livedemo.html - with links to the github cheatsheet, and to their extensions for email writing:

Right-click in the email and then click “Markdown Toggle”. (Or click the button on the toolbar. Or press CTRL+ALT+M)


An empty line followed by three minuses draws out a line across the email.


The toggling in and out of markdown looks neat at first but is actually a little snaggy, losing stuff written in markdown mode, and getting stuck trying to un-convert any existing markdown that you happen to be forwarding. And, worse, a lot of geeks find html email bad practice - probably for these kind of reasons. Might be better to stick to text.

Usage

Headings beyond level 4 lose their impact in a lot of markup convertors, so maybe just:

#### don't go beyond this level

formatting "Invictus"

I found this works best (first two verses of William Ernest Henley's magnificent poem:

<http://en.wikipedia.org/wiki/Invictus>

> Out of the night that covers me,
> Black as the pit from pole to pole,
> I thank whatever gods may be
> For my unconquerable soul.

> In the fell clutch of circumstance
> I have not winced nor cried aloud.
> Under the bludgeonings of chance
> My head is bloody, but unbowed. 

online checking

The original SM (Standard Markdown), from the creator of markdown (but in a tight view).

Jon Combe's clean two-panel editor - works fully in Firefox (can save your SM to a text or HTML file on your machine).

Pencil - zenly simple (but shows raw SM in a proportional font).

Syntax

Markdown: Syntax

Sublists are made by indenting 4 whitespaces, like this:

- 1327	Edward II is deposed
	- Edward III becomes King
	- Isabella & Mortimer govern
	- Scots invade England

Comments

Magnus' recommendation works (by creating a reference link [\/\/] that you never use):

 [//]: # (This may be the most platform independent comment)'' 

Implementing this in my many *.md notes files, this is the most compact start, including a horizontal line to separate from the toc, for my file Europe.md:

---
[//]: # ( vim: set fdm=expr:)

Does the cartography workshop where Christopher Columbus lived in Lisbon still exist? 

The space before the vim obviates a modeline error, and set is necessary here, and I can explain neither of these quirks.

cross_platform/encoding/text-code/lightweight_markup.txt · Last modified: 2016/10/05 10:45 (external edit)