v0

Markaround

A better Markdown (at least for me) with an emphasis on ease of writing (especially inside textareas) and parsing that supports consistent linking, content embeding, only one way to do something (I'm looking at you Markdown headers, lists, bold, emphasis), github style code blocks for easy copy-paste, header anchors, footer references and strikethrough (because you always change your mind).

content embeding, header anchors, footer references

designed primarily for ease-of-writing and optionally for ease-of-reading. This is unlike Markdown that emphasizes readability above all else.

Experience shows that Markdown is used more as a writing format and ossacionally published as-is. There is an aspect of readability that is important to the person editing a document, but in my opnion, it does not require the extermes that Markdown goes to with line breaks just to make blockquoting and multi-paragraph list items "look better" at the cost of easy of writing.

The other things that Markaround tries to improve upon Markdown are

• Being a "writing format for the web", Markaround focues on ease of writing inside textareas. It does this by avoiding white-space/indentation based syantax.

• A consistent linking syntax

• Ability to embed content

• Only one way to do something (unlike Markdown's headers, lists, emphasis)

• code block syntax for easy copy-posting code into documents

• header anchors

• footer references and

• a syntax for deleted text (becuase you always change your mind).

• *bold*

• _emphasis_

• -strikethrough-

• `inline code`

• Code Block

\`\`\`
Some Code
More Code
\`\`\`

• = Header 1 {#id .class} == Header 2 === Header 3 ==== Header 4 ===== Header 5 ====== Header 6
• * unordered list item 1 ** unordered list level 2 child-item 1 *** unordered list level 3 child-item 1 ** unordered list level 2 child-item 2 * unordered list item 2
• # ordered list item 1 ## ordered list level 2 child-item 1 ### ordered list level 3 child-item 1 # ordered list item 2
• Link
  • http://link
  • [http://link "title"]
  • (Link Text)[http://link "Title" .h-card >rel]
    • e.g., (Sandeep)[http://sandeep.io "Sandeep Shetty" .h-card >me]
  • (Link Text)[1]
    • [1]: http://link "title"
  • Some Text [^1]
    • [^1]: http://link "title"
• Embed
  • {{img_url}}
  • {{(video_url}} (note: uses oembed)
  • {{img_url}}[http://link "title"]
  • {{img_url}}[1]
    • [1]: http://link "title"
  • {{img_url �alt text�}}[http://link �title�]
• > blockquote
• Span
  • ((some text here)){#id .class1}

TODO:

• linebreaks
  • nl_to_br?
  • \n\n -> <p>?
  • explicit syntax for <br>? Maybe $?
  • multi-paragraph lists end with \n\n\n, i.e., two empty lines.
  • email-style blockquotes are imploded to remove \n
• http://maruku.rubyforge.org/proposal.html
• Metadata syntax to replace trailing tags invisible markup
• https://www.dokuwiki.org/wiki:syntax
  • interesting footnotes syntax
  • Also interesting image alignment syntax.
  • borrow emoticons.
  • See also text to html conversion.

References:

• Mandatory link to xkcd: http://xkcd.com/927/
• http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html
• http://www.wikimatrix.org/syntax.php?i=116&x=51&y=7
• http://www.wikicreole.org/wiki/Reasoning
• https://en.wikipedia.org/wiki/Lightweight_markup_language
• http://tantek.pbworks.com/w/page/59905776/Markdown
• http://c2.com/cgi/wiki?WikiDesignPrinciples
• http://c2.com/cgi/wiki?PrincipalComponentAnalysis
• http://www.wikicreole.org/wiki/Goals
• http://www.wikicreole.org/wiki/GoodPractices
• http://www.wikicreole.org/wiki/InvisibleMarkup
• Backticks Inspiration
  • http://php.net/manual/en/language.operators.execution.php
  • http://unix.stackexchange.com/questions/48392/understanding-backtick
• http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html
• http://www.rumproarious.com/2012/10/29/markdown-the-spec/
• https://github.com/dcurtis/markdown-mark
• http://code.google.com/p/pagedown/

Alternative names

• Mundane - inspired by the Wiki Design Principle of the same name: A small number of (irregular) text conventions will provide access to the most useful page markup
• flowt
• flowtext
• markforward
• markfwd
• markright
• markleft
• markrl (rl = rightleft)
• expressive
• pot (plain old text)
• syntext
• textmark (taken)
• lightmark (taken)
• plaintax