diff --git a/config.toml b/config.toml index 17439f0..1635a36 100644 --- a/config.toml +++ b/config.toml @@ -4,6 +4,7 @@ title = "Lotus Docs" theme = "lotusdocs" contentDir = "content" enableEmoji = true +enableGitInfo = true # N.B. .GitInfo does not currently function with submodule content directories [module] # uncomment line below for temporary local development of module @@ -15,15 +16,21 @@ enableEmoji = true path = "github.com/gohugoio/hugo-mod-bootstrap-scss/v5" disable = false +[markup] + defaultMarkdownHandler = "goldmark" + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/ + [params] # google_fonts = [ - # ["Nunito", "300, 400, 600, 700"], + # ["Nunito Sans", "300, 400, 600, 700"], # ["Source Code Pro", "500, 700"] # ] - # sans_serif_font = "Nunito" # Default is System font - # secondary_font = "Nunito" # Default is System font + # sans_serif_font = "Nunito Sans" # Default is System font + # secondary_font = "Nunito Sans" # Default is System font # mono_font = "Source Code Pro" # Default is System font [params.footer] @@ -31,10 +38,25 @@ enableEmoji = true version = true # includes git commit info [params.social] - github = "colinwilson/lotusdocs" # github.com/YOUR_GITHUB_ID - twitter = "lotusdocs" # twitter.com/YOUR_TWITTER_ID - # instagram = "colinwilson" # instagram.com/YOUR_INSTAGRAM_ID - # rss = true # show rss icon with link + github = "colinwilson/lotusdocs" # github.com/YOUR_GITHUB_ID + twitter = "lotusdocs" # twitter.com/YOUR_TWITTER_ID + # instagram = "colinwilson" # instagram.com/YOUR_INSTAGRAM_ID + # rss = true # show rss icon with link + + [params.docs] # Parameter fo the /docs 'template' + title = "Lotus Labs Documentation" # default html title for documentation pages/sections + breadcrumbs = true # default is true + backToTop = true # enable back-to-top button? default true + + toc = true # enable table of contents? default is true + scrollSpy = true # enable scrollspy on ToC? default is true + + descriptions = true # enable front matter descriptions under content title? + titleIcon = true # enable front matter icon title prefix? default is false + navDesc = true # include front matter descriptions in Prev/Next navigation cards + navDescTrunc = 30 # Number of characters by which to truncate the Prev/Next descriptions + + listDescTrunc = 100 # Number of characters by which to truncate the list card description [menu] # [[menu.primary]] diff --git a/content/docs/_index.md b/content/docs/_index.md index 7d39f6a..2206dc8 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -1,10 +1,11 @@ --- -title : "Lotus Docs" -description: "Documentation for the Lotus Docs Hugo Theme." -date: 2022-10-24T03:28:23+00:00 -lastmod: 2022-10-24T03:28:23+00:00 +weight: 10 +title: "Lotus Docs Documentation" +description: "Explore our guides and examples to deploy your docs using Lotus Docs." +icon: menu_book +lead: "" +date: 2022-10-10T02:21:15+00:00 +lastmod: 2022-10-10T02:21:15+00:00 draft: false images: [] ---- - -## Hello World \ No newline at end of file +--- \ No newline at end of file diff --git a/content/docs/contributing/_index.md b/content/docs/contributing/_index.md new file mode 100644 index 0000000..6bc78c6 --- /dev/null +++ b/content/docs/contributing/_index.md @@ -0,0 +1,11 @@ +--- +weight: 400 +title: "Contributing" +description: "Find out how to contribute to Lotus Labs." +icon: heart_plus +lead: "" +date: 2022-10-15T02:21:15+00:00 +lastmod: 2022-10-15T02:21:15+00:00 +draft: false +images: [] +--- \ No newline at end of file diff --git a/content/docs/contributing/code-of-conduct.md b/content/docs/contributing/code-of-conduct.md new file mode 100644 index 0000000..7b2dce8 --- /dev/null +++ b/content/docs/contributing/code-of-conduct.md @@ -0,0 +1,142 @@ +--- +title: "Code of Conduct" +icon: handshake +description: "Contributor Covenant Code of Conduct." +lead: "Contributor Covenant Code of Conduct." +date: 2022-10-15T02:21:15+00:00 +lastmod: 2022-10-15T02:21:15+00:00 +draft: false +images: [] +weight: 430 +toc: true +--- + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behaviour that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behaviour include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behaviour and will take appropriate and fair corrective action in +response to any behaviour that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behaviour may be +reported by contacting the project team at lotusdocs@aigis.uk. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behaviour deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behaviour was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behaviour. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behaviour. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behaviour, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations \ No newline at end of file diff --git a/content/docs/contributing/financial-contributions.md b/content/docs/contributing/financial-contributions.md new file mode 100644 index 0000000..0665f5c --- /dev/null +++ b/content/docs/contributing/financial-contributions.md @@ -0,0 +1,36 @@ +--- +title: "Financial Contributions" +icon: paid +description: "Help support the Lotus Labs development team by becoming a financial contributor." +lead: "Help support the Lotus Labs development team by becoming a financial contributor." +date: 2022-10-19T07:07:38+01:00 +lastmod: 2022-10-19T07:07:38+01:00 +draft: true +images: [] +weight: 420 +toc: true +--- + +We use [Open Collective](https://opencollective.com/) to receive contributions, share our budget, and manage expenses. Visit the [Doks Open Collective page](https://opencollective.com/doks). + +## Become a Sponsor + +Become a sponsor starting at $100.00 per month. Your logo — with a link to your website — will show up on the [Doks website](https://getdoks.org/), the [Doks repository](https://github.com/h-enk/doks), and the [Doks Open Collective page](https://opencollective.com/doks). + +[![Become a Sponsor](contribute-button.png)](https://opencollective.com/doks/contribute/sponsor-31303/checkout) + +## Become a Backer + +Become a backer starting at $5.00 per month. Your avatar will show up on the [Doks repository](https://github.com/h-enk/doks) and the [Doks Open Collective page](https://opencollective.com/doks). + +[![Become a Backer](contribute-button.png)](https://opencollective.com/doks/contribute/backer-31302/checkout) + +## Make a Donation + +Make a custom one-time or recurring contribution. + +[![Make a Donation](contribute-button.png)](https://opencollective.com/doks/donate) + +## Thanks :green_heart: + +Thanks for your contribution! diff --git a/content/docs/contributing/how-to-contribute.md b/content/docs/contributing/how-to-contribute.md new file mode 100644 index 0000000..88e74d9 --- /dev/null +++ b/content/docs/contributing/how-to-contribute.md @@ -0,0 +1,47 @@ +--- +title: "How to Contribute" +icon: volunteer_activism +description: "Contribute to code, improve documentation, help others, submit to showcase, and contribute financially." +lead: "Contribute to code, improve documentation, help others, submit to showcase, and contribute financially." +date: 2022-10-19T21:49:38+01:00 +lastmod: 2022-10-19T21:49:38+01:00 +draft: true +images: [] +weight: 410 +toc: true +--- + +## Contribute to code + +### Create an issue + +- [Bug report](https://github.com/h-enk/doks/issues/new?template=bug-report---.md) +- [Feature request](https://github.com/h-enk/doks/issues/new?template=feature-request---.md) + +### Create a Pull Request + +- Follow the [GitHub flow](https://guides.github.com/introduction/flow/). +- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/) + +## Improve documentation + + +- Follow the [GitHub flow](https://guides.github.com/introduction/flow/). +- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/) + +### Create an issue + +- [Bug report](https://github.com/h-enk/getdoks.org/issues/new?template=bug-report---.md) +- [Feature request](https://github.com/h-enk/getdoks.org/issues/new?template=feature-request---.md) + +## Help others + +[Doks Discussions](https://github.com/h-enk/doks/discussions) is the place to get help and help others with Doks. + +## Submit to showcase + +[Share what you’ve built with us](https://github.com/h-enk/doks/discussions?discussions_q=category%3A%22Show+and+tell%22). + +## Contribute financially + +Help support the team developing Doks by [becoming a financial contributor](/docs/contributing/financial-contributions/). \ No newline at end of file diff --git a/content/docs/get-started.md b/content/docs/get-started.md new file mode 100644 index 0000000..0d67aa5 --- /dev/null +++ b/content/docs/get-started.md @@ -0,0 +1,50 @@ ++++ +weight = 200 +date = "2022-09-30T05:34:22+01:00" +draft = true +author = "Colin Wilson" +title = "Get started" +icon = "rocket_launch" +# featured_image = "" +description = "Get started with Lotus Docs" +publishdate = "2022-09-30T05:34:22+01:00" +tags = ["Beginners","Guide"] +categories = [""] + +[twitter] + card = "summary" + site = "@LotusDocs" + creator = "@LotusDocs" + title = "Getting started" + description = "Getting started with Lotus Docs" + image = "" + ++++ + +## Account Sign Up + +One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin. + +## My Heading + +He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it and seemed ready to slide off any moment. + +### My Subheading + +Doubtful it stood; +As two spent swimmers, that do cling together +And choke their art. The merciless Macdonwald-- +Worthy to be a rebel, for to that +The multiplying villanies of nature +Do swarm upon him--from the western isles +Of kerns and gallowglasses is supplied; +And fortune, on his damned quarrel smiling, +Show'd like a rebel's whore: but all's too weak: +For brave Macbeth--well he deserves that name-- +Disdaining fortune, with his brandish'd steel, +Which smoked with bloody execution, +Like valour's minion carved out his passage +Till he faced the slave; +Which ne'er shook hands, nor bade farewell to him, +Till he unseam'd him from the nave to the chaps, +And fix'd his head upon our battlements. \ No newline at end of file diff --git a/content/docs/help/FAQs.md b/content/docs/help/FAQs.md new file mode 100644 index 0000000..97fa8b1 --- /dev/null +++ b/content/docs/help/FAQs.md @@ -0,0 +1,12 @@ +--- +title: "FAQ" +icon: "quiz" +description: "Answers to frequently asked questions." +lead: "Answers to frequently asked questions." +date: 2020-10-06T08:49:31+00:00 +lastmod: 2020-10-06T08:49:31+00:00 +draft: false +images: [] +weight: 520 +toc: true +--- diff --git a/content/docs/help/_index.md b/content/docs/help/_index.md new file mode 100644 index 0000000..5dd117f --- /dev/null +++ b/content/docs/help/_index.md @@ -0,0 +1,11 @@ +--- +weight: 500 +title: "Help" +description: "Help using the Lotus Docs theme." +icon: help +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +images: [] +--- \ No newline at end of file diff --git a/content/docs/help/troubleshooting.md b/content/docs/help/troubleshooting.md new file mode 100644 index 0000000..d8ca733 --- /dev/null +++ b/content/docs/help/troubleshooting.md @@ -0,0 +1,12 @@ +--- +title: "Troubleshooting" +icon: "tools_wrench" +description: "Solutions to common problems." +lead: "Solutions to common problems." +date: 2020-11-12T15:22:20+01:00 +lastmod: 2020-11-12T15:22:20+01:00 +draft: false +images: [] +weight: 510 +toc: true +--- diff --git a/content/docs/overview.md b/content/docs/overview.md new file mode 100644 index 0000000..b24e534 --- /dev/null +++ b/content/docs/overview.md @@ -0,0 +1,46 @@ ++++ +weight = 100 +date = "2022-09-30T05:33:22+01:00" +draft = false +author = "Colin Wilson" +title = "Overview" +icon = "circle" +toc = true +# featured_image = "https://res.cloudinary.com/qunux/image/upload/v1617231239/pgp_keys-03_jjogys.svg" +description = "Lotus Docs is a modern documentation theme built for Hugo." +publishdate = "2022-09-30T05:33:22+01:00" +tags = ["Beginners","Account"] +categories = [""] + +[twitter] + card = "summary" + site = "@LotusLabsUK" + creator = "@LotusLabsUK" + title = "Getting started" + description = "Getting started with Lotus Labs" + image = "https://res.cloudinary.com/qunux/image/upload/v1617231350/pgp_keys-03_h0soqe.png" ++++ + +{{< alert context="danger" >}} +Lotus Docs is currently in the very early stages of development and is therefore not ready for use in production. You're welcome to test the theme yourself and contributions to the project a very welcome. +{{< /alert >}} + +Welcome to the Lotus Docs user guide. This guide shows you how to get started creating technical documentation sites using Lotus Docs, including site customisation and how to use Lotus Docs' features and templates. + +## What is Lotus Docs? + +Lotus Docs is a theme for the [Hugo](https://gohugo.io) static site generator that’s specifically designed for technical documentation sets and includes many best practices by default. Use Lotus Docs to get a working and reliable documentation site up and running fast, leaving valuable time to focus creating content for your users. + +The site you’re currently reading was built using the Lotus Docs theme! Many of the features and configurations availble in the Lotus Docs theme are on display here. You can clone this entire site and edit it to suit your own projects, or just explore the site, its source and see what Lotus Docs can do. + +{{< alert context="warning" >}} +**Source hosting and management:** Our theme and [site source files](https://github.com/colinwilson/lotusdocs) live on GitHub, which is the simplest approach for most projects. However, you can also keep your project files in GitLab, BitBucket, locally, or wherever you like. Keep in mind that where your source files live may affect the Lotus Docs features you can use (such as letting users file documentation issues) and site deployment options. + +**Site deployment:** You can find out about deployment options in Previews and Deployment. This site uses [Vercel](https://vercel.com). +{{< /alert >}} + +## Is Lotus Docs for me? + +Lotus Docs is (currently) suited to small or medium technical documentation sets with 100 or less pages of docs. That's not to say Lotus Docs won't scale to larger documentation sets, just that its navigation and site structure may not be sufficient for larger data sets without heavy customisation. + +The good news is that development to accommodate larger sites is ongoing. So keep and eye on the [Lotus Docs GitHub repository](https://github.com/colinwilson/lotusdocs) for updates. \ No newline at end of file diff --git a/content/docs/overview/get-started.md b/content/docs/overview/get-started.md deleted file mode 100644 index 3ffc6fd..0000000 --- a/content/docs/overview/get-started.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -weight = 100 -title = "Get started" -icon = "rocket_launch" -date = "2022-09-30T05:34:22+01:00" -draft = true -author = "Colin Wilson" -# featured_image = "" -description = "Get started with Lotus Labs" -publishdate = "2022-09-30T05:34:22+01:00" -tags = ["Beginners","Account"] -categories = [""] - -[twitter] - card = "summary" - site = "@LotusDocs" - creator = "@LotusDocs" - title = "Get Started" - description = "Get started with Lotus Docs" - image = "" -+++ - -## Installing Lotus Docs \ No newline at end of file diff --git a/content/docs/test_markdown/_index.md b/content/docs/test_markdown/_index.md new file mode 100644 index 0000000..8b1734c --- /dev/null +++ b/content/docs/test_markdown/_index.md @@ -0,0 +1,11 @@ +--- +weight: 10000 +title: "Test Markdown" +description: "Test markdown pages for testing & development purposes. [NOT for public consumption]" +icon: science +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: true +images: [] +--- \ No newline at end of file diff --git a/content/docs/test_markdown/crash-test.md b/content/docs/test_markdown/crash-test.md new file mode 100644 index 0000000..a0112e3 --- /dev/null +++ b/content/docs/test_markdown/crash-test.md @@ -0,0 +1,710 @@ +--- +title: "Markdown Crash Test" +icon: bug_report +description: "A crash test markdown example page for basic testing & development (via roneo.org)." +lead: "An example markdown page for testing purposes." +date: 2022-10-19T04:11:15+00:00 +lastmod: 2022-10-19T04:12:15+00:00 +draft: true +images: [] +weight: 10030 +toc: true +--- + +## Benchmark Markdown Support + +Benchmarking the support of Markdown with a comprehensive checklist + +**Are you working on a project featuring Markdown?** + +Drop [the source of this page](https://raw.githubusercontent.com/RoneoOrg/markdown/main/README.md) wherever you want to test *or showcase* the support of Markdown, and check that every single feature is properly rendered. + + +**Table of Contents** + +- [Basic formatting](#basic-formatting) +- [Blockquotes](#blockquotes) +- [Lists](#lists) +- [Linebreaks](#linebreaks) +- [Links](#links) +- [Code formatting](#code-formatting) +- [Images](#images) +- [Task lists](#task-lists) +- [Tables](#tables) +- [Footnotes](#footnotes) +- [Definition List](#definition-list) +- [Headings](#headings) + + +## Basic formatting + +### **Bold** text + +**Syntax:** + + You can mark some text as bold with **two asterisks** + or __two underscores__. + +**Output:** + +You can mark some text as bold with **two asterisks** +or __two underscores__. + +### *Italic* + + Use a *single asterisk* or a _single underscore_ for italic. + +**Output:** + +Use a *single asterisk* or a _single underscore_ for italic. + +### ***Bold and italic*** + + Three stars gives `***bold and italic***` + +Three stars gives ***bold and italic*** + +### ~~Strikethrough~~ + +Using `~~two tildes~~` will strikethrough: ~~two tildes~~ + + + +## Blockquotes + +**Syntax:** + + > blockquote + +**Output**: + +> blockquote + +### Nested blockquotes + +**Syntax:** + + > First level + > + >> Second level + +**Output:** + +> First level +>> Second level + +### Markdown in blockquotes + +``` +> **Markdown** can be used *inside quotes* +> +> 1. This is the first list item. +> 1. This is the second list item. +> +> ~~strikethrough~~ +> +> Here's some example code: +> +> return shell_exec("echo $input | $markdown_script"); +``` + +**Output:** + +> **Markdown** can be used *inside quotes* +> 1. This is the first list item. +> 1. This is the second list item. +> +> ~~strikethrough~~ +> +> Here's some example code: +> +> return shell_exec("echo $input | $markdown_script"); + + +## Lists + + +### Unordered list + +Cant be marked with `-`, `+` or `*` + +```markdown +- First item +- Second item +- Third item +``` + +```markdown ++ First item ++ Second item ++ Third item +``` + +```markdown +* First item +* Second item +* Third item +``` + +**Output:** + +- First item +- Second item +- Third item + ++ First item ++ Second item ++ Third item + +* First item +* Second item +* Third item + +### Ordered lists + +Incrementation is automatic, you can simply use `1.` everywhere + +``` +1. First item +1. Second item +1. Third item +``` + +**Output:** + +1. First item +1. Second item +1. Third item + + + +### Nested list + +``` +- First item +- Second item +- Third item + 1. Indented item + 1. Indented item +- Fourth item +``` + +**Output:** + +- First item +- Second item +- Third item + 1. Indented item + 1. Indented item +- Fourth item + + +## Linebreaks + +**When you hit enter just once** between two lines, both lines are joined into a single paragraph. + +But, if you **leave a blank line between them**, they will split into two paragraphs. + +**Demonstration**: + +``` +This text is a paragraph. +This won't be another paragraph, it will join the line above it. + +This will be another paragraph, as it has a blank line above it. +``` + +**Output:** + +This text is a paragraph. This won't be another paragraph, it will join the line above it. + +This will be another paragraph, as it has a blank line above it. + +### Force line breaks + +To force a line break, **end a line with two or more whitespaces**, and then type return. + +``` +This is the first line.·· +Second line +``` + +**Output:** + +This is the first line. +Second line + +### Horizontal lines + +Can be inserted with four `*`, `-` or `_` + +``` +---- + +**** + +____ +``` + +**Output:** + +---- + +**** + +____ + + + + +## Links + + +### Basic links + +``` +[Semantic description](https://roneo.org/markdown) + + works too. Must be used for explicit links. +``` + +**Output:** + +[Semantic description](https://roneo.org/markdown) + + works too. Must be used for explicit links. + + +### Links using text reference + +``` +[I'm a link][Reference text] + +[This link] will do the same as well. It works as the identifier itself. + + +[reference text]: https://jamstack.club +[this link]: https://roneo.org/markdown +``` + +**Output:** + +[I'm a link][Reference text] + +[This link] will do the same as well. It works as the identifier itself. + + +[reference text]: https://jamstack.club +[this link]: https://roneo.org/markdown + +**Note:** The reference text is *not* case sensitive + + +### Link with a title on hover + +``` +[Random text][random-identifier]. +Hover the mouse over it to see the title. + +Several syntaxes are accepted: +[One](https://eff.org "First site") +[Two](https://example.com 'Second site') +[Three](https://example.com (Third site)) + +[random-identifier]: https://roneo.org/markdown "This example has a title" +``` + +**Output:** + +[Random text][random-identifier]. Hover the mouse over it to see the title. + +Several syntaxes are accepted: +[One](https://eff.org "First site") +[Two](https://jamstack.club 'Second site') +[Three](https://debian.org (Third site)) + +[random-identifier]: https://roneo.org/markdown "This example has a title" + + +### Links with Markdown style + +To ***emphasize*** links, add asterisks before and after the brackets and parentheses. + + I love supporting the **[EFF](https://eff.org)**. + This is the *[Markdown Guide](https://www.markdownguide.org)*. + +To denote links as `code`, add backticks *inside* the brackets: + + See the section on [`code`](#code). + +**Output:** + +I love supporting the **[EFF](https://eff.org)**. +This is the *[Markdown Guide](https://www.markdownguide.org)*. +See the section on [`code`](#code). + + +### Attribute a custom anchor to a heading + +Anchors are automatically generated based on the heading's content. You can customize the anchor this way: + + ### Heading {#custom-id} + +**Output:** + +#### Heading {#custom-id} + + + +## Code formatting + + +### Inline + +Wrap with single backticks to highlight as`` `code` `` → `code` + +### Codeblocks + +Create a code block with three backticks `` ``` `` before and after your block of code. + +**Output:** + + +``` +sudo apt hello +cat /etc/apt/sources.list +``` + +Also possible with a tabulation or four empty spaces at the beginning of the lines: + +**Tabulation** + + sudo apt hello + echo "hi" + +**Four whitespaces** + + sudo apt hello + +Let's test the wrapping of a long line: + + apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test apt install test + +### Codeblocks with syntax highlighting + +Set the language right after the first backticks (for example `` ```html ``) to get syntax highlighting + +#### Samples: + + +#### HTML + +```html + + + + + + +``` + +#### CSS + +```css +/* Comment */ +.blog-post h2, h3 { + margin-top: 1.6em; + margin-bottom: 0.8em; +} +``` + +#### Bash + +```bash +# Comment + +if [[ ! $system =~ Linux|MacOS|BSD ]]; then + echo "This version of bashtop does not support $system platform." + +sudo apt install test +``` + +#### Diff + +```diff +- delete ++ add +! test +# comment +``` + +### Escaping with backslashes + +Any ASCII punctuation character may be escaped using a single backslash. + +Example: + + \*this is not italic* + +**Output:** + +\*this is not italic* + +Markdown provides backslash escapes for the following characters: + + \ backslash + ` backtick + * asterisk + _ underscore + {} curly braces + [] square brackets + () parentheses + # hash mark + + plus sign + - minus sign (hyphen) + . dot + ! exclamation mark + + +## Images + +### Basic syntax + +``` markdown + ![Semantic description of the image](https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp) +``` + +![Semantic description of the image](https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp) + +**Note: The text inside the square brackets is important!** + +Screen reader users get informations about the image with this attribute called `ALT`, for _alternative text_. + +Including **descriptive** alt text [helps maintain accessibility](https://webaim.org/techniques/alttext/) for every visitor and should always be included with an image. When you add alt text be sure to describe the content and function of the picture. +In addition to the accessibility benefits, `ALT` is useful for SEO. It's also displayed when, for some reason, the picture is not loaded by the browser. + + +### Image with title and caption + +``` +![Semantic description](https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp "Your title")*Your caption* +``` + +![Semantic description](https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp "Your title")*Your caption* + + +### Clickable images + +For clickable images, simply wrap the image markup into a [link markup](#links): + +``` +[![Semantic description](https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp "Your title")](http://jamstack.club) +``` + +**Output:** + +[![Semantic description](https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp "Your title")](http://jamstack.club) + + + +### Image with an identifier + +You can call the image with an identifier as we do for [links](#links) + +``` +![Semantic desc.][image identifier] + +Lorem ipsum dolor sit amet consectetur adipisicing elit [...] + +[image identifier]: https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp "Title" +``` + +![Semantic desc.][image identifier] + +[image identifier]: https://res.cloudinary.com/qunux/image/upload/c_scale,w_200/v1666153179/Lotus%20Labs%20Assets/Logos/LotusLabs_Logo_v7.4.webp "Title" + + +## Task lists + +``` +- [X] Write the press release +- [ ] Update the website +``` + +**Output:** + +- [x] Write the press release +- [ ] Update the website + + + +## Tables + + +``` +| Syntax | Description | +| --------- | ----------- | +| Header | Title | +| Paragraph | Text | +``` + +or + +``` +| Syntax | Description | +| - | --- | +| Header | Title | +| Paragraph | Text| +``` + +will render the same way: + +| Syntax | Description | +| - | --- | +| Header | Title | +| Paragraph | Text| + + +### Text alignment in tables + + +``` +| Syntax | Description | Test Text | +| :-------- | :---------: | ----------: | +| Header | Title | Here's this | +| Paragraph | Text | And more | +``` + +See the way the text is aligned, depending on the position of `':'` + +| Syntax | Description | Test Text | +| :-------- | :---------: | ----------: | +| Header | Title | Here's this | +| Paragraph | Text | And more | + + + +## Footnotes + +``` +Here's a sentence with a footnote[^1]. +(see the result at the bottom of the page) + +[^1]: This is the first footnote. +``` + +**Output:** + +Here's a sentence with a footnote[^1]. +(see the result at the bottom of the page) + +[^1]: This is the first footnote. + +### Long footnote + +``` +Here's a longer one.[^bignote] +(see the result at the bottom of the page) + +[^bignote]: Here's one with multiple paragraphs and code. + + Indent paragraphs to include them in the footnote. + + `{ my code }` + + Note that you can place the footnote anywhere you want in your article +``` + +**Output:** + +Here's a longer one.[^bignote] +(see the result at the bottom of the page) + +[^bignote]: Here's one with multiple paragraphs and code. + + Indent paragraphs to include them in the footnote. + + `{ my code }` + + Note that you can place the footnote anywhere you want in your article + + + +## Definition List + + +``` +term +: definition + +second term +: meaning + +complex term +: long definition including **bold text**. Velit tempor cillum aute culpa pariatur enim laboris consectetur tempor. Aute elit non do ipsum. Nisi quis culpa magna esse ipsum. Ad aliquip ullamco minim cillum in ullamco. +``` + +**Output:** + +term +: definition + +second term +: meaning + +complex term +: long definition including **bold text**. Velit tempor cillum aute culpa pariatur enim laboris consectetur tempor. Aute elit non do ipsum. Nisi quis culpa magna esse ipsum. Ad aliquip ullamco minim cillum in ullamco. + + +## Headings + +Add `##` at the beginning of a line to set as Heading. +You can use up to 6 `#` symbols for the corresponding Heading levels + + +``` +## Heading 1 +[...] + +###### Heading 6 +``` + + +## Heading 2 + +pedit quia voluptates atque nobis, perspiciatis deserunt perferendis, nostrum, voluptatem voluptas dolorem iure voluptatum? Accusantium a dolores dicta?Pariatur voluptates quam ut, cum aliquid eum, officiis laudantium totam suscipit, ducimus odit nobis! Corrupti, doloremque sed optio voluptatibus deserunt quas repellat eius minus quasi, ipsam unde esse sequi deleniti. + + +### Heading 3 ################################## + +pedit quia voluptates atque nobis, perspiciatis deserunt perferendis, nostrum, voluptatem voluptas dolorem iure voluptatum? Accusantium a dolores dicta?Pariatur voluptates quam ut, cum aliquid eum, officiis laudantium totam suscipit, ducimus odit nobis! Corrupti, doloremque sed optio voluptatibus deserunt quas repellat eius minus quasi, ipsam unde esse sequi deleniti. + +#### Heading 4 + +pedit quia voluptates atque nobis, perspiciatis deserunt perferendis, nostrum, voluptatem voluptas dolorem iure voluptatum? Accusantium a dolores dicta?Pariatur voluptates quam ut, cum aliquid eum, officiis laudantium totam suscipit, ducimus odit nobis! Corrupti, doloremque sed optio voluptatibus deserunt quas repellat eius minus quasi, ipsam unde esse sequi deleniti. + +##### Heading 5 + +pedit quia voluptates atque nobis, perspiciatis deserunt perferendis, nostrum, voluptatem voluptas dolorem iure voluptatum? Accusantium a dolores dicta?Pariatur voluptates quam ut, cum aliquid eum, officiis laudantium totam suscipit, ducimus odit nobis! Corrupti, doloremque sed optio voluptatibus deserunt quas repellat eius minus quasi, ipsam unde esse sequi deleniti. + +###### Heading 6 + +pedit quia voluptates atque nobis, perspiciatis deserunt perferendis, nostrum, voluptatem voluptas dolorem iure voluptatum? Accusantium a dolores dicta?Pariatur voluptates quam ut, cum aliquid eum, officiis laudantium totam suscipit, ducimus odit nobis! Corrupti, doloremque sed optio voluptatibus deserunt quas repellat eius minus quasi, ipsam unde esse sequi deleniti. + + +## References + +- Source of this page: [github.com/RoneoOrg/markdown](https://github.com/RoneoOrg/markdown) +- [Markdown Guide - Basic Syntax](https://www.markdownguide.org/basic-syntax) +- [Markdown Guide - Extended Syntax](https://www.markdownguide.org/extended-syntax) +- [Daring Fireball: Markdown Syntax Documentation](https://daringfireball.net/projects/markdown/syntax) +- [Markdown Guide at Gitlab.com](https://about.gitlab.com/handbook/markdown-guide/) +- [CommonMark Spec](https://spec.commonmark.org/0.29/) + +## Related projects + +- https://github.com/ericwbailey/markdown-test-file +- https://scottspence.com/posts/writing-with-markdown +- https://codingnconcepts.com/markdown/markdown-syntax/ +- https://codeit.suntprogramator.dev/basic-markdown-syntax/ +- https://daringfireball.net/projects/markdown/syntax.text \ No newline at end of file diff --git a/content/docs/test_markdown/doks-readme.md b/content/docs/test_markdown/doks-readme.md new file mode 100644 index 0000000..6fccc5d --- /dev/null +++ b/content/docs/test_markdown/doks-readme.md @@ -0,0 +1,172 @@ +--- +title: "DOKS Readme" +# icon: +description: "DOKS Documentation theme readme." +lead: "An example markdown page for testing purposes." +date: 2022-10-23T3:51:15+00:00 +lastmod: 2022-10-23T3:51:15+00:00 +draft: true +images: [] +weight: 10050 +toc: true +--- + +

+ + Doks + +

+ +

+ Doks +

+ +

+ Modern Documentation Theme +

+ +

+ Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize. +

+ +

+ + GitHub + + + GitHub release (latest SemVer including pre-releases) + + + npm (scoped) + + + GitHub Workflow Status (branch) + + + Netlify + +

+ +![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/doks.png) + +## Demo + +- [doks.netlify.app](https://doks.netlify.app/) + +## Why Doks? + +Nine main reasons why you should use Doks: + +1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs. + +2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=59aafe464a68f8bc30b8e9a636d5b053) by default. Doks removes unused css, prefetches links, and lazy loads images. + +3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking. + +4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually. + +5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files. + +6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers. + +7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking. + +8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs. + +9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding. + +### Other features + +- __Multilingual and i18n__ support +- __Versioning__ documentation support +- __KaTeX__ math typesetting +- __Mermaid__ diagrams and visualization +- __highlight.js__ syntax highlighting + +## Requirements + +- [Git](https://git-scm.com/) — latest source release +- [Node.js](https://nodejs.org/) — latest LTS version or newer + +
+Why Node.js? + +Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts. + +
+ +## Get started + +Start a new Doks project in three steps: + +### 1. Create a new site + +Doks is available as a child theme and a starter theme. + +#### Child theme + +- Intended for novice to intermediate users +- Intended for minor customizations +- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks) + +```bash +git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site +``` + +#### Starter theme + +- Intended for intermediate to advanced users +- Intended for major customizations +- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) + +```bash +git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site +``` + +
+Help me choose + +Not sure which one is for you? Pick the child theme. + +
+ +### 2. Install dependencies + +```bash +npm install +``` + +### 3. Start development server + +```bash +npm run start +``` + +## Other commands + +Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks. + +## Documentation + +- [Netlify](https://docs.netlify.com/) +- [Hugo](https://gohugo.io/documentation/) +- [Doks](https://getdoks.org/) + +## Communities + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) +- [Doks Discussions](https://github.com/h-enk/doks/discussions) + +## Sponsors + +Support this project by becoming a sponsor. Your logo will show up here with a link to your website. + +[![OC sponsor 0](https://opencollective.com/doks/tiers/sponsor/0/avatar.svg)](https://opencollective.com/doks/tiers/sponsor/0/website) +[![OC sponsor 1](https://opencollective.com/doks/tiers/sponsor/1/avatar.svg)](https://opencollective.com/doks/tiers/sponsor/1/website) + +## Backers + +Support this project by becoming a backer. Your avatar will show up here. + +[![Backers](https://opencollective.com/doks/tiers/backer.svg?49741992)](https://opencollective.com/doks) diff --git a/content/docs/test_markdown/katex+mermaid.md b/content/docs/test_markdown/katex+mermaid.md new file mode 100644 index 0000000..a400150 --- /dev/null +++ b/content/docs/test_markdown/katex+mermaid.md @@ -0,0 +1,156 @@ +--- +title: "Katex + Mermaid" +icon: function +description: "A Katex + Mermaid markdown example page for basic testing & development (via StackEdit)." +lead: "An example markdown page for testing purposes." +date: 2022-10-19T03:54:15+00:00 +lastmod: 2022-10-19T03:54:15+00:00 +draft: true +images: [] +weight: 10020 +toc: true +--- + +# Welcome to StackEdit! + +Hi! I'm your first Markdown file in **StackEdit**. If you want to learn about StackEdit, you can read me. If you want to play with Markdown, you can edit me. Once you have finished with me, you can create new files by opening the **file explorer** on the left corner of the navigation bar. + + +# Files + +StackEdit stores your files in your browser, which means all your files are automatically saved locally and are accessible **offline!** + +## Create files and folders + +The file explorer is accessible using the button in left corner of the navigation bar. You can create a new file by clicking the **New file** button in the file explorer. You can also create folders by clicking the **New folder** button. + +## Switch to another file + +All your files and folders are presented as a tree in the file explorer. You can switch from one to another by clicking a file in the tree. + +## Rename a file + +You can rename the current file by clicking the file name in the navigation bar or by clicking the **Rename** button in the file explorer. + +## Delete a file + +You can delete the current file by clicking the **Remove** button in the file explorer. The file will be moved into the **Trash** folder and automatically deleted after 7 days of inactivity. + +## Export a file + +You can export the current file by clicking **Export to disk** in the menu. You can choose to export the file as plain Markdown, as HTML using a Handlebars template or as a PDF. + + +# Synchronization + +Synchronization is one of the biggest features of StackEdit. It enables you to synchronize any file in your workspace with other files stored in your **Google Drive**, your **Dropbox** and your **GitHub** accounts. This allows you to keep writing on other devices, collaborate with people you share the file with, integrate easily into your workflow... The synchronization mechanism takes place every minute in the background, downloading, merging, and uploading file modifications. + +There are two types of synchronization and they can complement each other: + +- The workspace synchronization will sync all your files, folders and settings automatically. This will allow you to fetch your workspace on any other device. + > To start syncing your workspace, just sign in with Google in the menu. + +- The file synchronization will keep one file of the workspace synced with one or multiple files in **Google Drive**, **Dropbox** or **GitHub**. + > Before starting to sync files, you must link an account in the **Synchronize** sub-menu. + +## Open a file + +You can open a file from **Google Drive**, **Dropbox** or **GitHub** by opening the **Synchronize** sub-menu and clicking **Open from**. Once opened in the workspace, any modification in the file will be automatically synced. + +## Save a file + +You can save any file of the workspace to **Google Drive**, **Dropbox** or **GitHub** by opening the **Synchronize** sub-menu and clicking **Save on**. Even if a file in the workspace is already synced, you can save it to another location. StackEdit can sync one file with multiple locations and accounts. + +## Synchronize a file + +Once your file is linked to a synchronized location, StackEdit will periodically synchronize it by downloading/uploading any modification. A merge will be performed if necessary and conflicts will be resolved. + +If you just have modified your file and you want to force syncing, click the **Synchronize now** button in the navigation bar. + +> **Note:** The **Synchronize now** button is disabled if you have no file to synchronize. + +## Manage file synchronization + +Since one file can be synced with multiple locations, you can list and manage synchronized locations by clicking **File synchronization** in the **Synchronize** sub-menu. This allows you to list and remove synchronized locations that are linked to your file. + + +# Publication + +Publishing in StackEdit makes it simple for you to publish online your files. Once you're happy with a file, you can publish it to different hosting platforms like **Blogger**, **Dropbox**, **Gist**, **GitHub**, **Google Drive**, **WordPress** and **Zendesk**. With [Handlebars templates](http://handlebarsjs.com/), you have full control over what you export. + +> Before starting to publish, you must link an account in the **Publish** sub-menu. + +## Publish a File + +You can publish your file by opening the **Publish** sub-menu and by clicking **Publish to**. For some locations, you can choose between the following formats: + +- Markdown: publish the Markdown text on a website that can interpret it (**GitHub** for instance), +- HTML: publish the file converted to HTML via a Handlebars template (on a blog for example). + +## Update a publication + +After publishing, StackEdit keeps your file linked to that publication which makes it easy for you to re-publish it. Once you have modified your file and you want to update your publication, click on the **Publish now** button in the navigation bar. + +> **Note:** The **Publish now** button is disabled if your file has not been published yet. + +## Manage file publication + +Since one file can be published to multiple locations, you can list and manage publish locations by clicking **File publication** in the **Publish** sub-menu. This allows you to list and remove publication locations that are linked to your file. + + +# Markdown extensions + +StackEdit extends the standard Markdown syntax by adding extra **Markdown extensions**, providing you with some nice features. + +> **ProTip:** You can disable any **Markdown extension** in the **File properties** dialog. + + +## 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| + + +## KaTeX + +You can render LaTeX mathematical expressions using [KaTeX](https://khan.github.io/KaTeX/): + +The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral + +$$ +\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. +$$ + +> You can find more information about **LaTeX** mathematical expressions [here](http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference). + + +## UML diagrams + +You can render UML diagrams using [Mermaid](https://mermaidjs.github.io/). For example, this will produce a sequence diagram: + +```mermaid +sequenceDiagram +Alice ->> Bob: Hello Bob, how are you? +Bob-->>John: How about you John? +Bob--x Alice: I am good thanks! +Bob-x John: I am good thanks! +Note right of John: Bob thinks a long
long time, so long
that the text does
not fit on a row. + +Bob-->Alice: Checking with John... +Alice->John: Yes... John, how are you? +``` + +And this will produce a flow chart: + +```mermaid +graph LR +A[Square Rect] -- Link text --> B((Circle)) +A --> C(Round Rect) +B --> D{Rhombus} +C --> D +``` diff --git a/content/docs/test_markdown/unorthodox.md b/content/docs/test_markdown/unorthodox.md new file mode 100644 index 0000000..86c4c8d --- /dev/null +++ b/content/docs/test_markdown/unorthodox.md @@ -0,0 +1,105 @@ +--- +title: "Unorthodox Cases 🦄" +icon: fingerprint +description: "A custom markdown example page for testing of specific or rare styling cases." +lead: "An example markdown page for testing purposes." +date: 2022-10-20T00:29:15+00:00 +lastmod: 2022-10-20T00:29:15+00:00 +draft: true +images: [] +weight: 10040 +toc: true +--- + +## Shortcode Notifications/Alerts + +Various notification styles: + +{{< alert >}} +The Tutorial is intended for novice to intermediate users.
Hello World +{{< /alert >}} + +{{< alert context="info" >}} +**Markdown** and HTML will be rendered. This next sentence [demonstrates](https://colinwilson.uk) the colour of a link inside an alert box. We’re currently designing a new way to integrate the Payment Element, which allows you to create the PaymentIntent or SetupIntent after you render the Payment Element. If you’re interested in learning more about this feature. + +*Beginning* of a second paragraph. +{{< /alert >}} + +{{< alert icon="🎃" context="info" >}} +The default context icon can be overridden with an emoji by setting the named parameter icon to the emoji of choice. e.g. {{\< alert icon="🎃" text="Make sure to always self-close the alert shortcode." />}} +{{< /alert >}} + +{{< alert icon=" " context="primary" >}} +The default context icon can be overridden to display no icon by setting the named parameter icon to an empty space. e.g. +``` +{{\< alert icon=" " text="Make sure to always self-close the alert shortcode." />}} +``` +{{< /alert >}} + +{{< alert icon="🌕" context="light" text="An light context alert using an emoji (:full_moon:) instead of the default icon." />}} + +{{< alert icon="🌑" context="dark" text="An alert using an emoji (:jack_o_lantern:) instead of the default context icon." />}} + +{{< alert context="primary">}} +The Tutorial is intended for novice to intermediate users. + +This next sentence [demonstrates](https://colinwilson.uk) the colour of a link inside an alert box. +{{< /alert >}} + +{{< alert context="success" text="The Tutorial is intended for novice to intermediate users.
Hello World" />}} + +{{< alert context="warning" text="The Tutorial is intended for novice to intermediate users.
Hello World" />}} + +{{< alert context="danger" text="The Tutorial is intended for novice to intermediate users.
Hello World" />}} + +{{< alert context="secondary" >}} +The Tutorial is intended for novice to intermediate users.
Hello World +This next sentence [demonstrates](https://colinwilson.uk) the colour of a link inside an alert box. +{{< /alert >}} + +## Small Image + +![Redis](https://res.cloudinary.com/qunux/image/upload/v1643320066/isometric_redis_proxy_icon_nmf5dm.webp) +## Large Image + +![Argo CD Vault Plugin](https://res.cloudinary.com/qunux/image/upload/c_scale,w_1200/v1651719756/argocd_vault_plugin_lg_v2.7b_prz2ad.webp) +## Super Large Image + +![External Secrets with Argo CD](https://res.cloudinary.com/qunux/image/upload/v1660827109/argocd_eso_how_it_works_v1.3_lg_yw7zen.webp) + +## Ordered/Unordered Heading lists + +1. # Heading \ +2. # Heading \ + +- # Heading \ + + +1. ## Heading \ +2. ## Heading \ + +- ## Heading \ + + +1. ### Heading \ +2. ### Heading \ + +- ### Heading \ + + +1. #### Heading \ +2. #### Heading \ + +- #### Heading \ + + +1. ##### Heading \ +2. ##### Heading \ + +- ##### Heading \ + + +1. ###### Heading \ +2. ###### Heading \ + +- ###### Heading \ diff --git a/content/docs/test_markdown/vanilla-markdown.md b/content/docs/test_markdown/vanilla-markdown.md new file mode 100644 index 0000000..a7fc6b7 --- /dev/null +++ b/content/docs/test_markdown/vanilla-markdown.md @@ -0,0 +1,317 @@ +--- +title: "Vanilla Markdown" +icon: icecream +description: "A vanilla markdown example page for basic testing & development." +lead: "An example markdown page for testing purposes." +date: 2022-10-19T02:42:15+00:00 +lastmod: 2022-10-19T02:42:15+00:00 +draft: true +images: [] +weight: 10010 +toc: true +--- + +# Markdown: Syntax + +- [Markdown: Syntax](#markdown-syntax) + - [Overview](#overview) + - [Philosophy](#philosophy) + - [Block Elements](#block-elements) + - [Paragraphs and Line Breaks](#paragraphs-and-line-breaks) + - [Headers](#headers) + - [Blockquotes](#blockquotes) + - [Lists](#lists) + - [Code Blocks](#code-blocks) + - [Span Elements](#span-elements) + - [Links](#links) + - [Emphasis](#emphasis) + - [Code](#code) + + +**Note:** This document is itself written using Markdown; you +can [see the source for it by adding '.text' to the URL](/projects/markdown/syntax.text). + +---- + +## Overview + +### Philosophy + +Markdown is intended to be as easy-to-read and easy-to-write as is feasible. + +Readability, however, is emphasized above all else. A Markdown-formatted +document should be publishable as-is, as plain text, without looking +like it's been marked up with tags or formatting instructions. While +Markdown's syntax has been influenced by several existing text-to-HTML +filters -- including [Setext](http://docutils.sourceforge.net/mirror/setext.html), [atx](http://www.aaronsw.com/2002/atx/), [Textile](http://textism.com/tools/textile/), [reStructuredText](http://docutils.sourceforge.net/rst.html), +[Grutatext](http://www.triptico.com/software/grutatxt.html), and [EtText](http://ettext.taint.org/doc/) -- the single biggest source of +inspiration for Markdown's syntax is the format of plain text email. + +## Block Elements + +### Paragraphs and Line Breaks + +A paragraph is simply one or more consecutive lines of text, separated +by one or more blank lines. (A blank line is any line that looks like a +blank line -- a line containing nothing but spaces or tabs is considered +blank.) Normal paragraphs should not be indented with spaces or tabs. + +The implication of the "one or more consecutive lines of text" rule is +that Markdown supports "hard-wrapped" text paragraphs. This differs +significantly from most other text-to-HTML formatters (including Movable +Type's "Convert Line Breaks" option) which translate every line break +character in a paragraph into a `
` tag. + +When you *do* want to insert a `
` break tag using Markdown, you +end a line with two or more spaces, then type return. + +### Headers + +Markdown supports two styles of headers, [Setext] [1] and [atx] [2]. + +Optionally, you may "close" atx-style headers. This is purely +cosmetic -- you can use this if you think it looks better. The +closing hashes don't even need to match the number of hashes +used to open the header. (The number of opening hashes +determines the header level.) + + +### Blockquotes + +Markdown uses email-style `>` characters for blockquoting. If you're +familiar with quoting passages of text in an email message, then you +know how to create a blockquote in Markdown. It looks best if you hard +wrap the text and put a `>` before every line: + +> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, +> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. +> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus. +> +> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +> id sem consectetuer libero luctus adipiscing. + +Markdown allows you to be lazy and only put the `>` before the first +line of a hard-wrapped paragraph: + +> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, +consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. +Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus. + +> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing. + +Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by +adding additional levels of `>`: + +> This is the first level of quoting. +> +> > This is nested blockquote. +> +> Back to the first level. + +Blockquotes can contain other Markdown elements, including headers, lists, +and code blocks: + +> ## This is a header. +> +> 1. This is the first list item. +> 2. This is the second list item. +> +> Here's some example code: +> +> return shell_exec("echo $input | $markdown_script"); + +Any decent text editor should make email-style quoting easy. For +example, with BBEdit, you can make a selection and choose Increase +Quote Level from the Text menu. + + +### Lists + +Markdown supports ordered (numbered) and unordered (bulleted) lists. + +Unordered lists use asterisks, pluses, and hyphens -- interchangably +-- as list markers: + +* Red +* Green +* Blue + +is equivalent to: + ++ Red ++ Green ++ Blue + +and: + +- Red +- Green +- Blue + +Ordered lists use numbers followed by periods: + +1. Bird +2. McHale +3. Parish + +It's important to note that the actual numbers you use to mark the +list have no effect on the HTML output Markdown produces. The HTML +Markdown produces from the above list is: + +If you instead wrote the list in Markdown like this: + +1. Bird +1. McHale +1. Parish + +or even: + +3. Bird +1. McHale +8. Parish + +you'd get the exact same HTML output. The point is, if you want to, +you can use ordinal numbers in your ordered Markdown lists, so that +the numbers in your source match the numbers in your published HTML. +But if you want to be lazy, you don't have to. + +To make lists look nice, you can wrap items with hanging indents: + +* Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, + viverra nec, fringilla in, laoreet vitae, risus. +* Donec sit amet nisl. Aliquam semper ipsum sit amet velit. + Suspendisse id sem consectetuer libero luctus adipiscing. + +But if you want to be lazy, you don't have to: + +* Lorem ipsum dolor sit amet, consectetuer adipiscing elit. +Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, +viverra nec, fringilla in, laoreet vitae, risus. +* Donec sit amet nisl. Aliquam semper ipsum sit amet velit. +Suspendisse id sem consectetuer libero luctus adipiscing. + +List items may consist of multiple paragraphs. Each subsequent +paragraph in a list item must be indented by either 4 spaces +or one tab: + +1. This is a list item with two paragraphs. Lorem ipsum dolor + sit amet, consectetuer adipiscing elit. Aliquam hendrerit + mi posuere lectus. + + Vestibulum enim wisi, viverra nec, fringilla in, laoreet + vitae, risus. Donec sit amet nisl. Aliquam semper ipsum + sit amet velit. + +2. Suspendisse id sem consectetuer libero luctus adipiscing. + +It looks nice if you indent every line of the subsequent +paragraphs, but here again, Markdown will allow you to be +lazy: + +* This is a list item with two paragraphs. + + This is the second paragraph in the list item. You're +only required to indent the first line. Lorem ipsum dolor +sit amet, consectetuer adipiscing elit. + +* Another item in the same list. + +To put a blockquote within a list item, the blockquote's `>` +delimiters need to be indented: + +* A list item with a blockquote: + + > This is a blockquote + > inside a list item. + +To put a code block within a list item, the code block needs +to be indented *twice* -- 8 spaces or two tabs: + +* A list item with a code block: + + + +### Code Blocks + +Pre-formatted code blocks are used for writing about programming or +markup source code. Rather than forming normal paragraphs, the lines +of a code block are interpreted literally. Markdown wraps a code block +in both `
` and `` tags.
+
+To produce a code block in Markdown, simply indent every line of the
+block by at least 4 spaces or 1 tab.
+
+This is a normal paragraph:
+
+    This is a code block.
+
+Here is an example of AppleScript:
+
+    tell application "Foo"
+        beep
+    end tell
+
+A code block continues until it reaches a line that is not indented
+(or the end of the article).
+
+Within a code block, ampersands (`&`) and angle brackets (`<` and `>`)
+are automatically converted into HTML entities. This makes it very
+easy to include example HTML source code using Markdown -- just paste
+it and indent it, and Markdown will handle the hassle of encoding the
+ampersands and angle brackets. For example, this:
+
+    
+
+Regular Markdown syntax is not processed within code blocks. E.g.,
+asterisks are just literal asterisks within a code block. This means
+it's also easy to use Markdown to write about Markdown's own syntax.
+
+```
+tell application "Foo"
+    beep
+end tell
+```
+
+## Span Elements
+
+### Links
+
+Markdown supports two style of links: *inline* and *reference*.
+
+In both styles, the link text is delimited by [square brackets].
+
+To create an inline link, use a set of regular parentheses immediately
+after the link text's closing square bracket. Inside the parentheses,
+put the URL where you want the link to point, along with an *optional*
+title for the link, surrounded in quotes. For example:
+
+This is [an example](http://example.com/) inline link.
+
+[This link](http://example.net/) has no title attribute.
+
+### Emphasis
+
+Markdown treats asterisks (`*`) and underscores (`_`) as indicators of
+emphasis. Text wrapped with one `*` or `_` will be wrapped with an
+HTML `` tag; double `*`'s or `_`'s will be wrapped with an HTML
+`` tag. E.g., this input:
+
+*single asterisks*
+
+_single underscores_
+
+**double asterisks**
+
+__double underscores__
+
+### Code
+
+To indicate a span of code, wrap it with backtick quotes (`` ` ``).
+Unlike a pre-formatted code block, a code span indicates code within a
+normal paragraph. For example:
+
+Use the `printf()` function. `"type": "sepa_debit"`
diff --git a/themes/lotusdocs b/themes/lotusdocs
index 8ec2e80..546b2ce 160000
--- a/themes/lotusdocs
+++ b/themes/lotusdocs
@@ -1 +1 @@
-Subproject commit 8ec2e80fccdc69b1b0d475200ebf05da176aca40
+Subproject commit 546b2ce992b6c65dcd0a4d0979c186a283bc8661