aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2018-03-23 10:12:20 +0000
committerps-george <george.punter15@imperial.ac.uk>2018-03-23 10:12:20 +0000
commitec43fd6f3eb486d4493827793834268aeede9211 (patch)
tree57fe60d78c759f14de5aeaf867e09842fb43bbe5 /examples
parent2ff041b2ff5f3f6a5dca248cf4ed36e1e0b378e0 (diff)
downloadFMark-ec43fd6f3eb486d4493827793834268aeede9211.tar.gz
FMark-ec43fd6f3eb486d4493827793834268aeede9211.zip
Adding tests for %% (#165)
* Going through ps-george list for readmes_examples * separating vanilla markdown into implemented list and design decisions * Updating format * moving build passing * adding link to examples.fmark * Individual README * README updates * Update README.md * Update README.md * Update README.md * Update README.md * typo fix * Adding tests for %% * Adding CLI and markalc docs * remove .html file, can generate from example.fmark * adding js
Diffstat (limited to 'examples')
-rw-r--r--examples/example.fmark19
-rw-r--r--examples/example.html192
2 files changed, 14 insertions, 197 deletions
diff --git a/examples/example.fmark b/examples/example.fmark
index a22859e..c89b991 100644
--- a/examples/example.fmark
+++ b/examples/example.fmark
@@ -3,8 +3,8 @@
{{ include ./macros.fmark }}
## Table of contents
-
-%%TOC
+<!-- Relative links do not work in VS code, use Create HTML File. -->
+%%TOC depth=3
## Macros
@@ -46,6 +46,8 @@
***Both*** or ___both___
+~~strikethrough~~
+
Note: _underscores_ must have a space on either side.
# Heading 1
@@ -89,9 +91,17 @@ Unordered List 2:
### Links
[Google](http://www.google.com)
+
<!-- Images produce correct HTML but don't display in VS Code-->
![image](test_img.jpg)
+<!-- Relative links do not work in VS code, use Create HTML File -->
+<a href="#this-header"> Relative link. </a>
+
+### HTML passthrough
+<!-- HTML is left unchanged. -->
+<h2 id="this-header"><a href="broken-link"> A broken link. </a></h2>
+
## LateX maths
$$2* \begin{pmatrix}
@@ -118,12 +128,11 @@ Here are some[^1] words, and more words[^2].
### References
-All footnotes are collected and displayed at the end of the document[^Eric].
+All footnotes are collected and displayed at the end of the document[^Smith].
The style of references are set at the top of the document.
-[^Eric], type = Book, author = Not Eric, year = 2018, title = An Introduction to FMark
+[^Smith], type = Book, author = FMark Smith, year = 2018, title = An Introduction to FMark
Note: Simple footnotes takes numerical IDs, and references need alphabetical IDs.
Look the footers are rendered in order below this line.
-
diff --git a/examples/example.html b/examples/example.html
deleted file mode 100644
index 5b8d288..0000000
--- a/examples/example.html
+++ /dev/null
@@ -1,192 +0,0 @@
-<!DOCTYPE html>
-
-<head>
- <meta name="viewport" content="width=device-width">
- <title>/Users/g2/Documents/EIE3/FMark-vscode/src/Fmark/examples/</title>
-</head>
-
-<body>
- <h1 id="FMark_Example0">FMark Example</h1>
- <h2 id="Table_of_contents1">Table of contents</h2>
- <ol>
- <li>
- <a href="#FMark_Example0">FMark Example</a>
- </li>
- <ol>
- <li>
- <a href="#Table_of_contents1">Table of contents</a>
- </li>
- <li>
- <a href="#Macros2">Macros</a>
- </li>
- <li>
- <a href="#Including_files3">Including files</a>
- </li>
- <li>
- <a href="#Spreadsheet_functionality4">Spreadsheet functionality</a>
- </li>
- <li>
- <a href="#Standard_Markdown5">Standard Markdown</a>
- </li>
- <ol>
- <li>
- <a href="#Styling6">Styling</a>
- </li>
- </ol>
- </ol>
- <li>
- <a href="#Heading_17">Heading 1</a>
- </li>
- <li>
- <a href="#Heading_28">Heading 2</a>
- </li>
- <ol>
- <li>
- <a href="#Heading_39">Heading 3</a>
- </li>
- </ol>
- <ol>
- <li>
- <a href="#Heading_410">Heading 4</a>
- </li>
- </ol>
- <ol>
- <li>
- <a href="#Heading_511">Heading 5</a>
- </li>
- </ol>
- <li>
- <a href="#Heading_612">Heading 6</a>
- </li>
- <li>
- <a href="#Lists13">Lists</a>
- </li>
- <li>
- <a href="#Links14">Links</a>
- </li>
- <li>
- <a href="#LateX_maths15">LateX maths</a>
- </li>
- </ol>
- <h2 id="Macros2">Macros</h2>
- <table>
- <thead>
- <tr>
- <th>default</th>
- <th>table</th>
- <th>contents</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>hi</td>
- <td>my</td>
- <td>name</td>
- </tr>
- <tr>
- <td>is</td>
- <td>FMark</td>
- <td>hi</td>
- </tr>
- </tbody>
- </table>
- <h2 id="Including_files3">Including files</h2>
- <p>This is an included file!
- <br> This is a second included file.</p>
- <h2 id="Spreadsheet_functionality4">Spreadsheet functionality</h2>
- <table>
- <thead>
- <tr>
- <th>This</th>
- <th>is</th>
- <th>FMark</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>5</td>
- <td>3</td>
- <td>8</td>
- </tr>
- <tr>
- <td>2</td>
- <td>3</td>
- <td>5.33</td>
- </tr>
- </tbody>
- </table>
- <h2 id="Standard_Markdown5">Standard Markdown</h2>
- <h3 id="Styling6">Styling</h3>
- <p>
- <em>Emphasis</em> or
- <em>Emphasis</em>
- </p>
- <p>
- <strong>Bold</strong> or
- <strong>bold</strong>
- </p>
- <p>
- <em>
- <strong>Both</strong>
- </em> or
- <em>
- <strong>both</strong>
- </em>
- </p>
- <p>Note:
- <em>underscores</em> must have a space on either side.</p>
- <h1 id="Heading_17">Heading 1</h1>
- <h2 id="Heading_28">Heading 2</h2>
- <h3 id="Heading_39">Heading 3</h3>
- <h4 id="Heading_410">Heading 4</h4>
- <h5 id="Heading_511">Heading 5</h5>
- <h5 id="Heading_612">Heading 6</h5>
- <h3 id="Lists13">Lists</h3>
- <p>Ordered List:</p>
- <ol>
- <li>First</li>
- <li>Second</li>
- <ol>
- <ol>
- <li>Nested First</li>
- <li>Nested Second</li>
- </ol>
- </ol>
- <li>Third</li>
- </ol>
- <p>Unordered List:</p>
- <ul>
- <li>First</li>
- <li>Second</li>
- <ul>
- <ul>
- <li>Nested First</li>
- <li>Nested Second</li>
- </ul>
- </ul>
- <li>Third</li>
- </ul>
- <p>Unordered List 2:</p>
- <ul>
- <li>First</li>
- <li>Second</li>
- <ul>
- <ul>
- <li>Nested First</li>
- <li>Nested Second</li>
- </ul>
- </ul>
- <li>Third</li>
- </ul>
- <h3 id="Links14">Links</h3>
- <p>
-
- <a href="http://www.google.com">Google</a>
- <!-- Images produce correct HTML but don't display in VS Code-->
- <img src="test_img.jpg" alt="image">
- </p>
- <h2 id="LateX_maths15">LateX maths</h2>
- <p>$$2* \begin{pmatrix} x_{00} & x_{01} & x_{01} \newline x_{10} & x_{11} & x_{11} \newline x_{20} & x_{21} & x_{21} \end{pmatrix}$$</p>
- <script
- type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
-</body> \ No newline at end of file