aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/meta_data.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan.limberg@icloud.com>2015-03-08 21:08:31 -0400
committerWaylan Limberg <waylan.limberg@icloud.com>2015-03-08 21:08:31 -0400
commit4f9d4fff86c638ab2edb569ad9eb14f82728808d (patch)
treeabd6855ebb0fdffa6a8ed13b7ed06d2fde1b3864 /docs/extensions/meta_data.txt
parentf54cd8652df84d5f8655819fff0631f0fc92a2b6 (diff)
downloadmarkdown-4f9d4fff86c638ab2edb569ad9eb14f82728808d.tar.gz
markdown-4f9d4fff86c638ab2edb569ad9eb14f82728808d.tar.bz2
markdown-4f9d4fff86c638ab2edb569ad9eb14f82728808d.zip
Removed `yaml` option from meta-data extension.
The option was buggy. Rather than try to fix it, it is being removed. This feeture should exist as a seperate extension. Fixes #390.
Diffstat (limited to 'docs/extensions/meta_data.txt')
-rw-r--r--docs/extensions/meta_data.txt24
1 files changed, 5 insertions, 19 deletions
diff --git a/docs/extensions/meta_data.txt b/docs/extensions/meta_data.txt
index 3057bfa..4a4fe62 100644
--- a/docs/extensions/meta_data.txt
+++ b/docs/extensions/meta_data.txt
@@ -47,10 +47,11 @@ many lines as desired.
The first blank line ends all meta-data for the document. Therefore, the first
line of a document must not be blank.
-Alternatively, if the first line in the document is `---`, a YAML document
-separator, then the meta-data is searched for between it and the next `---`
-(or `...`) line. Even though YAML deliminators are supported, meta-data is
-not parsed as YAML unless the `yaml` option is set (see below).
+Alternatively, You may use YAML style deliminators to mark the start and/or end
+of your meta-data. When doing so, the first line of your document must be `---`.
+The meta-data ends at the first blank line or the first line containing an end
+deliminator (either `---` or `...`), whichever comes first. Even though YAML
+deliminators are supported, meta-data is not parsed as YAML.
All meta-data is stripped from the document prior to any further processing
by Markdown.
@@ -61,16 +62,6 @@ Usage
See [Extensions](index.html) for general extension usage, specify `markdown.extensions.meta`
as the name of the extension.
-The following options are provided to configure the output:
-
-* **`yaml`**: Support meta-data specified in YAML format.
-
- Default: `False`
-
- If `yaml` is set to `True`, the lines between `---` separators are parsed
- as a full YAML object. PyYAML is required for this, and a warning is
- issued if PyYAML (or equivalent) is not available.
-
Accessing the Meta-Data
-----------------------
@@ -100,11 +91,6 @@ line breaks if desired. Or the items could be joined where appropriate. No
assumptions are made regarding the data. It is simply passed as found to the
`Meta` attribute.
-Note, if `yaml` option is set, the resulting `Meta` attribute is the object as
-returned by `yaml.load()` and may deviate significantly from the above
-description (e.g. may be a list of dictionaries, with value objects other than
-strings, ...).
-
Perhaps the meta-data could be passed into a template system, or used by
various Markdown extensions. The possibilities are left to the imagination of
the developer.