123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 |
- <!doctype html>
- <title>CodeMirror: YAML front matter mode</title>
- <meta charset="utf-8"/>
- <link rel=stylesheet href="../../doc/docs.css">
- <link rel="stylesheet" href="../../lib/codemirror.css">
- <script src="../../lib/codemirror.js"></script>
- <script src="../../addon/mode/overlay.js"></script>
- <script src="../markdown/markdown.js"></script>
- <script src="../gfm/gfm.js"></script>
- <script src="../yaml/yaml.js"></script>
- <script src="yaml-frontmatter.js"></script>
- <style>.CodeMirror { border-top: 1px solid #ddd; border-bottom: 1px solid #ddd; }</style>
- <div id=nav>
- <a href="https://codemirror.net"><h1>CodeMirror</h1><img id=logo src="../../doc/logo.png"></a>
- <ul>
- <li><a href="../../index.html">Home</a>
- <li><a href="../../doc/manual.html">Manual</a>
- <li><a href="https://github.com/codemirror/codemirror">Code</a>
- </ul>
- <ul>
- <li><a href="../index.html">Language modes</a>
- <li><a class=active href="#">YAML-Frontmatter</a>
- </ul>
- </div>
- <article>
- <h2>YAML front matter mode</h2>
- <form><textarea id="code" name="code">
- ---
- receipt: Oz-Ware Purchase Invoice
- date: 2007-08-06
- customer:
- given: Dorothy
- family: Gale
- items:
- - part_no: A4786
- descrip: Water Bucket (Filled)
- price: 1.47
- quantity: 4
- - part_no: E1628
- descrip: High Heeled "Ruby" Slippers
- size: 8
- price: 100.27
- quantity: 1
- bill-to: &id001
- street: |
- 123 Tornado Alley
- Suite 16
- city: East Centerville
- state: KS
- ship-to: *id001
- specialDelivery: >
- Follow the Yellow Brick
- Road to the Emerald City.
- Pay no attention to the
- man behind the curtain.
- ---
- GitHub Flavored Markdown
- ========================
- Everything from markdown plus GFM features:
- ## URL autolinking
- Underscores_are_allowed_between_words.
- ## Strikethrough text
- GFM adds syntax to strikethrough text, which is missing from standard Markdown.
- ~~Mistaken text.~~
- ~~**works with other formatting**~~
- ~~spans across
- lines~~
- ## Fenced code blocks (and syntax highlighting)
- ```javascript
- for (var i = 0; i < items.length; i++) {
- console.log(items[i], i); // log them
- }
- ```
- ## Task Lists
- - [ ] Incomplete task list item
- - [x] **Completed** task list item
- ## A bit of GitHub spice
- * SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
- * User@SHA ref: mojombo@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
- * User/Project@SHA: mojombo/god@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
- * \#Num: #1
- * User/#Num: mojombo#1
- * User/Project#Num: mojombo/god#1
- See http://github.github.com/github-flavored-markdown/.
- </textarea></form>
- <p>Defines a mode that parses
- a <a href="http://jekyllrb.com/docs/frontmatter/">YAML frontmatter</a>
- at the start of a file, switching to a base mode at the end of that.
- Takes a mode configuration option <code>base</code> to configure the
- base mode, which defaults to <code>"gfm"</code>.</p>
- <script>
- var editor = CodeMirror.fromTextArea(document.getElementById("code"), {mode: "yaml-frontmatter"});
- </script>
- </article>
|