From 3db55c1f265454f3749c41080df9ddf2c905c18f Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Fri, 29 Oct 2021 16:09:30 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20content=20samples?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- exampleSite/content/samples/_index.md | 4 +- .../content/samples/diagrams-flowcharts.md | 90 +++++++++++++++++++ exampleSite/content/samples/emoji-support.md | 22 ----- exampleSite/content/samples/emoji.md | 19 ++++ .../{markdown-syntax.md => markdown.md} | 4 +- .../content/samples/placeholder-text.md | 12 +-- 6 files changed, 114 insertions(+), 37 deletions(-) create mode 100755 exampleSite/content/samples/diagrams-flowcharts.md delete mode 100755 exampleSite/content/samples/emoji-support.md create mode 100755 exampleSite/content/samples/emoji.md rename exampleSite/content/samples/{markdown-syntax.md => markdown.md} (94%) diff --git a/exampleSite/content/samples/_index.md b/exampleSite/content/samples/_index.md index fcce5fef..2d9820c9 100755 --- a/exampleSite/content/samples/_index.md +++ b/exampleSite/content/samples/_index.md @@ -11,9 +11,7 @@ cascade: Congo brings your content to life. :heart_eyes: {{< /lead >}} -This section contains some demo pages that show how Congo renders different types of content. These pages come from Hugo's official [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample) repository. - -You can also see an example [taxonomy listing]({{< ref "tags" >}}) page. +This section contains some demo pages that show how Congo renders different types of content. You can also see an example [taxonomy listing]({{< ref "tags" >}}) page. _**Sidenote:** This page is just a standard Congo article listing and Hugo has been configured to generate a `samples` content type and display article summaries._ diff --git a/exampleSite/content/samples/diagrams-flowcharts.md b/exampleSite/content/samples/diagrams-flowcharts.md new file mode 100755 index 00000000..d815552d --- /dev/null +++ b/exampleSite/content/samples/diagrams-flowcharts.md @@ -0,0 +1,90 @@ +--- +title: "Diagrams and Flowcharts" +date: 2019-03-06 +description: "Guide to Mermaid usage in Congo" +summary: "It's easy to add diagrams and flowcharts to articles using Mermaid." +tags: ["mermaid", "sample", "diagram"] +--- + +Mermaid diagrams are supported in Congo using the `mermaid` shortcode. Simply wrap the diagram markup within the shortcode. Congo automatically themes Mermaid diagrams to match the configured `colorScheme` parameter. + +The examples below are a small selection taken from the [official Mermaid docs](https://mermaid-js.github.io/mermaid/). You can also [view the page source](https://raw.githubusercontent.com/jpanther/congo/dev/exampleSite/content/samples/diagrams-flowcharts.md) on GitHub to see the markup. + +## Flowchart + +{{< mermaid >}} +graph TD +A[Christmas] -->|Get money| B(Go shopping) +B --> C{Let me think} +B --> G[/Another/] +C ==>|One| D[Laptop] +C -->|Two| E[iPhone] +C -->|Three| F[Car] +subgraph Section +C +D +E +F +G +end +{{< /mermaid >}} + +## Sequence diagram + +{{< mermaid >}} +sequenceDiagram +autonumber +par Action 1 +Alice->>John: Hello John, how are you? +and Action 2 +Alice->>Bob: Hello Bob, how are you? +end +Alice->>+John: Hello John, how are you? +Alice->>+John: John, can you hear me? +John-->>-Alice: Hi Alice, I can hear you! +Note right of John: John is perceptive +John-->>-Alice: I feel great! +loop Every minute +John-->Alice: Great! +end +{{< /mermaid >}} + +## Class diagram + +{{< mermaid >}} +classDiagram +Animal "1" <|-- Duck +Animal <|-- Fish +Animal <--o Zebra +Animal : +int age +Animal : +String gender +Animal: +isMammal() +Animal: +mate() +class Duck{ ++String beakColor ++swim() ++quack() +} +class Fish{ +-int sizeInFeet +-canEat() +} +class Zebra{ ++bool is_wild ++run() +} +{{< /mermaid >}} + +## Entity relationship diagram + +{{< mermaid >}} +erDiagram +CUSTOMER }|..|{ DELIVERY-ADDRESS : has +CUSTOMER ||--o{ ORDER : places +CUSTOMER ||--o{ INVOICE : "liable for" +DELIVERY-ADDRESS ||--o{ ORDER : receives +INVOICE ||--|{ ORDER : covers +ORDER ||--|{ ORDER-ITEM : includes +PRODUCT-CATEGORY ||--|{ PRODUCT : contains +PRODUCT ||--o{ ORDER-ITEM : "ordered in" +{{< /mermaid >}} diff --git a/exampleSite/content/samples/emoji-support.md b/exampleSite/content/samples/emoji-support.md deleted file mode 100755 index e522e6d2..00000000 --- a/exampleSite/content/samples/emoji-support.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Emoji Support" -date: 2019-03-05 -description: "Guide to emoji usage in Hugo" -summary: "📖🏞️🧗🏽🪂🐉🧙🏽‍♂️🧚🏽👸" -tags: ["emoji", "sample"] ---- - -Emoji can be enabled in a Hugo project in a number of ways. - -The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes). - -To enable emoji globally, set `enableEmoji` to `true` in your site's [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g. - -

🙈 :see_no_evil: 🙉 :hear_no_evil: 🙊 :speak_no_evil:

-
- -The [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) is a useful reference for emoji shorthand codes. - ---- - -**N.B.** The above steps enable Unicode Standard emoji characters and sequences in Hugo, however the rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack. diff --git a/exampleSite/content/samples/emoji.md b/exampleSite/content/samples/emoji.md new file mode 100755 index 00000000..4823a415 --- /dev/null +++ b/exampleSite/content/samples/emoji.md @@ -0,0 +1,19 @@ +--- +title: "Emoji" +date: 2019-03-05 +description: "Guide to Emoji usage in Congo" +summary: "📖🏞️🧗🏽🪂🐉🧙🏽‍♂️🧚🏽👸" +tags: ["emoji", "sample"] +--- + +Emoji is supported throughout Congo by default. Emoji can be used in titles, menu items and article content. + +{{< alert >}} +**Note:** The rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack. +{{< /alert >}} + +Emoji replacements are controlled via the `enableEmoji` parameter in your [site configuration]({{< ref "configuration#site-configuration" >}}). Set it to `true` and then you can type Emoji shorthand codes directly in content files. + +**Example:** `see_no_evil` :see_no_evil:, `hear_no_evil` :hear_no_evil:, `speak_no_evil` :speak_no_evil:. + +The [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) is a useful reference for emoji shorthand codes. diff --git a/exampleSite/content/samples/markdown-syntax.md b/exampleSite/content/samples/markdown.md similarity index 94% rename from exampleSite/content/samples/markdown-syntax.md rename to exampleSite/content/samples/markdown.md index 9b5821b1..a163f0f4 100755 --- a/exampleSite/content/samples/markdown-syntax.md +++ b/exampleSite/content/samples/markdown.md @@ -1,11 +1,11 @@ --- -title: "Markdown Syntax Guide" +title: "Markdown" date: 2019-03-11 description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements." tags: ["markdown", "css", "html", "sample"] --- -This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. +This article offers a sample of basic Markdown formatting that can be used in Congo, also it shows how some basic HTML elements are decorated. diff --git a/exampleSite/content/samples/placeholder-text.md b/exampleSite/content/samples/placeholder-text.md index a28b3f2d..5228caa5 100755 --- a/exampleSite/content/samples/placeholder-text.md +++ b/exampleSite/content/samples/placeholder-text.md @@ -22,24 +22,16 @@ Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silen 4. Arcanaque montibus omnes 5. Quidem et -# Vagus elidunt +## Vagus elidunt [The Van de Graaf Canon](https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon) -## Mane refeci capiebant unda mulcebat +### Mane refeci capiebant unda mulcebat Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. **Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis. Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et. Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel **mitis temploque** vocatus, inque alis, _oculos nomen_ non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**. - -{{< css.inline >}} - - - -{{< /css.inline >}}