Minor remarkup updates

Summary:
  - Update documentation for changes in D1148.
  - Link to Remarkup documentation from Maniphest.
  - Support "Note:" syntax in Phabricator (previously, it was only supported in
Diviner, but I've found it pretty good and useful).

Test Plan: Regenerated and perused documentation; made a "NOTE:".

Reviewers: btrahan, broofa, fugalh, jungejason, nh, aran

Reviewed By: btrahan

CC: aran, btrahan

Differential Revision: 1149
This commit is contained in:
epriestley
2011-12-01 09:48:27 -08:00
parent dfffc78d38
commit c53511e9b4
6 changed files with 165 additions and 129 deletions

View File

@@ -25,8 +25,8 @@ formatting text in Remarkup:
{F123} # Embed Images
[[wiki page]] # Link to Phriction
@username # Mention a user
Indent two spaces for code.
Indent two spaces with "-" for lists.
Use "- " or "* " for list items.
Use ``` or indent two spaces for code.
= Basic Styling =
@@ -49,23 +49,34 @@ Make **headers** like this:
This produces headers like the ones in this document.
Make **lists** by indenting two spaces and beginning each item with a "-":
Make **lists** by beginning each item with a "-" or a "*":
lang=text
- milk
- eggs
- bread
* duck
* duck
* goose
This produces a list like this:
- milk
- eggs
- bread
(Note that you need to put a space after the "-" or "*".)
Make **code blocks** by indenting two spaces:
f(x, y);
You can also use three backticks to enclose the code block:
```f(x, y);
g(f);```
You can specify a language for syntax highlighting with "lang=xxx":
lang=text
@@ -94,6 +105,10 @@ This produces a block like this:
global $$variable_variable;
}
You can also use "NOTE:" to call out an important idea.
NOTE: Don't cross the streams!
= Linking URIs =
URIs are automatically linked: http://phabricator.org/