Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README with new metadata format.

  • Loading branch information...
commit 38209d92a049533b7efe5df873f24e1c5b074675 1 parent f34834d
@jgm authored
Showing with 10 additions and 7 deletions.
  1. +10 −7 README.markdown
View
17 README.markdown
@@ -146,20 +146,23 @@ Page metadata
Pages may optionally begin with a metadata block. Here is an example:
- !format: latex+lhs
- !categories: haskell math
- !toc: no
- !title: Haskell and
+ ---
+ format: latex+lhs
+ categories: haskell math
+ toc: no
+ title: Haskell and
Category Theory
+ ...
\section{Why Category Theory?}
- ...
The metadata block consists of a list of key-value pairs, each on a separate
line. If needed, the value can be continued on one or more additional
line, which must begin with a space. (This is illustrated by the "title"
-example above.) The metadata block must be separated from the main text
-of the article by a blank line.
+example above.) The metadata block must begin with a line `---` and end with
+a line `...` followed by one or more blank lines. (The metadata block is a
+valid YAML document, though not all YAML documents will be valid metadata
+blocks.)
Currently the following keys are supported:
Please sign in to comment.
Something went wrong with that request. Please try again.