revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-23 14:00:56 +01:00
Code Issues Releases Wiki Activity

Clarify header block documentation

Browse source 
Summary: Make it more explicit that headers are block formatters, see T778.

Test Plan: Read docs.

Reviewers: davidreuss, btrahan, jungejason

Reviewed By: btrahan

CC: aran

Maniphest Tasks: T778

Differential Revision: https://secure.phabricator.com/D1420
This commit is contained in:
epriestley 2012-01-16 11:45:43 -08:00
parent 80643d63a8
commit 5333b16d7f
1 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/docs/userguide/remarkup.diviner
View file

@ -14,17 +14,23 @@ This document describes how to format text using Remarkup.
= Quick Reference = = Quick Reference =
All the syntax is explained in more detail below, but this is a quick guide to All the syntax is explained in more detail below, but this is a quick guide to
formatting text in Remarkup: formatting text in Remarkup.
These are inline styles, and can be applied to most text:
**bold** //italic// ##monospaced## **bold** //italic// ##monospaced##
= Large Header=
== Smaller Header ==
> Quoted Text
D123 T123 rX123 # Link to Objects D123 T123 rX123 # Link to Objects
{D123} {T123} # Link to Objects (Full Name) {D123} {T123} # Link to Objects (Full Name)
{F123} # Embed Images {F123} # Embed Images
[[wiki page]] # Link to Phriction [[wiki page]] # Link to Phriction
@username # Mention a user @username # Mention a user
These are block styles, and must be separated from surrounding text by
empty lines:
= Large Header=
== Smaller Header ==
> Quoted Text
Use "- " or "* " for list items. Use "- " or "* " for list items.
Use ``` or indent two spaces for code. Use ``` or indent two spaces for code.
Use %%% for a literal block. Use %%% for a literal block.
@ -45,10 +51,13 @@ respectively.
Make **headers** like this: Make **headers** like this:
= Large Header = = Large Header =
== Smaller Header == == Smaller Header ==
===== Very Small Header ===== ===== Very Small Header =====
This produces headers like the ones in this document. This produces headers like the ones in this document. Make sure you have an
empty line before and after the header.
Make **lists** by beginning each item with a "-" or a "*": Make **lists** by beginning each item with a "-" or a "*":