diff options
author | Stephane Desneux <stephane.desneux@iot.bzh> | 2016-11-08 12:39:57 +0100 |
---|---|---|
committer | Stephane Desneux <stephane.desneux@iot.bzh> | 2016-11-10 14:53:01 +0100 |
commit | c530e84843444a40804e0c2b038c2ec53fe411b2 (patch) | |
tree | 1a9eebf49fd85027ba472bad8c178d686bad8d56 /site/misc |
webdocs-agl: added developer website template
Change-Id: I4a45ee0ad5dd0c29a6d6876a0e02cd5550c010e9
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'site/misc')
-rw-r--r-- | site/misc/demo/index.md | 163 | ||||
-rw-r--r-- | site/misc/feed.xml | 30 |
2 files changed, 193 insertions, 0 deletions
diff --git a/site/misc/demo/index.md b/site/misc/demo/index.md new file mode 100644 index 0000000..196e9ad --- /dev/null +++ b/site/misc/demo/index.md @@ -0,0 +1,163 @@ +--- + +title: Test Markdown to UML +author: Fulup Ar Foll (IoT.bzh) +date: 2016-06-30 + +categories: [architecture, appfw] +tags: [architecture, signal, message] +layout: umlflowdoc + +--- + +Markdown Extra +-------------------- + +StackEdit supports **Markdown Extra**, which extends **Markdown** syntax with some nice features. + +> **Tip:** You can disable any **Markdown Extra** feature in the **Extensions** tab of the <i class="icon-cog"></i> **Settings** dialog. + +> **Note:** You can find more information about **Markdown** syntax [here][2] and **Markdown Extra** extension [here][3]. + + +### Tables + +**Markdown Extra** has a special syntax for tables: + +Item | Value +-------- | --- +Computer | $1600 +Phone | $12 +Pipe | $1 + +You can specify column alignment with one or two colons: + +| Item | Value | Qty | +| :------- | ----: | :---: | +| Computer | $1600 | 5 | +| Phone | $12 | 12 | +| Pipe | $1 | 234 | + + +### Definition Lists + +**Markdown Extra** has a special syntax for definition lists too: + +Term 1 +Term 2 +: Definition A +: Definition B + +Term 3 + +: Definition C + +: Definition D + + > part of definition D + + +### Fenced code blocks + +GitHub's fenced code blocks are also supported with **Highlight.js** syntax highlighting: + +``` +// Foo +var bar = 0; +``` + +> **Tip:** To use **Prettify** instead of **Highlight.js**, just configure the **Markdown Extra** extension in the <i class="icon-cog"></i> **Settings** dialog. + +> **Note:** You can find more information: + +> - about **Prettify** syntax highlighting [here][5], +> - about **Highlight.js** syntax highlighting [here][6]. + + +### Footnotes + +You can create footnotes like this[^footnote]. + + [^footnote]: Here is the *text* of the **footnote**. + + +### SmartyPants + +SmartyPants converts ASCII punctuation characters into "smart" typographic punctuation HTML entities. For example: + +| | ASCII | HTML | + ----------------- | ---------------------------- | ------------------ +| Single backticks | `'Isn't this fun?'` | 'Isn't this fun?' | +| Quotes | `"Isn't this fun?"` | "Isn't this fun?" | +| Dashes | `-- is en-dash, --- is em-dash` | -- is en-dash, --- is em-dash | + + +### Table of contents + +You can insert a table of contents using the marker `[TOC]`: + +1. TOC +{:toc} + + +### UML diagrams + +You can also render sequence diagrams like this: + +~~~ +Alice->Bob: Hello Bob, how are you? +Note right of Bob: Bob thinks +Bob-->Alice: I am good thanks! +~~~ + +~~~ UML + Alice->Bob: Hello Bob, how are you? + Note right of Bob: Bob thinks + Bob-->Alice: I am good thanks! +~~~ + +``` UML-hand +Alice->Bob: Hello Bob, how are you? +Note right of Bob: Bob thinks +Bob-->Alice: I am good thanks! +``` + +And flow charts like this: + +``` + st=>start: Start + e=>end + op=>operation: My Operation + cond=>condition: Yes or No? + + st->op->cond + cond(yes)->e + cond(no)->op +``` + +``` FLOW +st=>start: Start +e=>end +op=>operation: My Operation +cond=>condition: Yes or No? + +st->op->cond +cond(yes)->e +cond(no)->op +``` + + +> **Note:** You can find more information: + +> - about **Sequence diagrams** syntax [here][7], +> - about **Flow charts** syntax [here][8]. + + + [1]: http://math.stackexchange.com/ + [2]: http://daringfireball.net/projects/markdown/syntax "Markdown" + [3]: https://github.com/jmcmanus/pagedown-extra "Pagedown Extra" + [4]: http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference + [5]: https://code.google.com/p/google-code-prettify/ + [6]: http://highlightjs.org/ + [7]: http://bramp.github.io/js-sequence-diagrams/ + [8]: http://adrai.github.io/flowchart.js/ diff --git a/site/misc/feed.xml b/site/misc/feed.xml new file mode 100644 index 0000000..626f4f9 --- /dev/null +++ b/site/misc/feed.xml @@ -0,0 +1,30 @@ +--- +layout: null +--- +<?xml version="1.0" encoding="UTF-8"?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>{{ site.title | xml_escape }}</title> + <description>{{ site.description | xml_escape }}</description> + <link>{{ site.url }}{{ site.baseurl }}/</link> + <atom:link href="{{ site.url }}{{ site.baseurl }}{{ site.rss_path}}" rel="self" type="application/rss+xml"/> + <pubDate>{{ site.time | date_to_rfc822 }}</pubDate> + <lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate> + <generator>Jekyll v{{ jekyll.version }}</generator> + {% for post in site.posts limit:10 %} + <item> + <title>{{ post.title | xml_escape }}</title> + <description>{{ post.content | xml_escape }}</description> + <pubDate>{{ post.date | date_to_rfc822 }}</pubDate> + <link>{{ site.url }}{{ site.baseurl }}{{ post.url }}</link> + <guid isPermaLink="true">{{ site.url }}{{ site.baseurl }}{{ post.url }}</guid> + {% for tag in post.tags %} + <category>{{ tag | xml_escape }}</category> + {% endfor %} + {% for cat in post.categories %} + <category>{{ cat | xml_escape }}</category> + {% endfor %} + </item> + {% endfor %} + </channel> +</rss> |