diff options
| author | vjeantet <valere.jeantet@gmail.com> | 2020-09-10 22:37:52 +0300 |
|---|---|---|
| committer | vjeantet <valere.jeantet@gmail.com> | 2020-09-10 22:37:52 +0300 |
| commit | 8862fd899a376596f65b9bc3a377fe87c3797586 (patch) | |
| tree | 11a3e9192805f5854fe1996293236a4acd8d9139 | |
| parent | 20dd6fd67dc18c9604ad3e6a4e230061ac321730 (diff) | |
convert all frontmatter to YAML
64 files changed, 286 insertions, 298 deletions
diff --git a/exampleSite/content/404.md b/exampleSite/content/404.md index e7fcdff..c980dfc 100644 --- a/exampleSite/content/404.md +++ b/exampleSite/content/404.md @@ -1,10 +1,10 @@ --- -title: Whoops! Page not found +date: "2020-09-08T20:40:23.389Z" description: This is a 404 page -date: 2020-09-08T20:40:23.389Z -layout: page hidden: true hide: toc, nav, breadcrumb, nextpage +layout: page +title: Whoops! Page not found url: 404.html --- That page can't be found. diff --git a/exampleSite/content/_layout/footer/_index.md b/exampleSite/content/_layout/footer/_index.md index 08a41d6..600271f 100644 --- a/exampleSite/content/_layout/footer/_index.md +++ b/exampleSite/content/_layout/footer/_index.md @@ -1,7 +1,7 @@ --- -title: Footer -date: 2020-08-20T15:41:15.543Z +date: "2020-08-20T15:41:15.543Z" description: Footer +title: Footer --- <style type="text/css"> diff --git a/exampleSite/content/_layout/netlifycms/_index.md b/exampleSite/content/_layout/netlifycms/_index.md index a0b7431..b8e2a14 100644 --- a/exampleSite/content/_layout/netlifycms/_index.md +++ b/exampleSite/content/_layout/netlifycms/_index.md @@ -1,4 +1,4 @@ ----
-
----
+--- +{} +--- fake
\ No newline at end of file diff --git a/exampleSite/content/_layout/netlifycms/config.md b/exampleSite/content/_layout/netlifycms/config.md index e344010..1d97d50 100644 --- a/exampleSite/content/_layout/netlifycms/config.md +++ b/exampleSite/content/_layout/netlifycms/config.md @@ -1,10 +1,8 @@ ----
-title: "Netlify config file"
-url: /admin/config.yml
-outputs:
- - netlifyyaml
-
-netlifycms_content_folder : "exampleSite/content"
-
----
+--- +netlifycms_content_folder: exampleSite/content +outputs: +- netlifyyaml +title: Netlify config file +url: /admin/config.yml +--- diff --git a/exampleSite/content/_layout/netlifycms/root.md b/exampleSite/content/_layout/netlifycms/root.md index c12b7cb..1efc1d2 100644 --- a/exampleSite/content/_layout/netlifycms/root.md +++ b/exampleSite/content/_layout/netlifycms/root.md @@ -1,8 +1,8 @@ ----
-render: raw
-title: Content Manager
-url: /admin/index.html
----
+--- +render: raw +title: Content Manager +url: /admin/index.html +--- <html>
<head>
<meta charset="utf-8" />
diff --git a/exampleSite/content/_layout/sidebar-after/_index.md b/exampleSite/content/_layout/sidebar-after/_index.md index 7be3f77..ca527f7 100644 --- a/exampleSite/content/_layout/sidebar-after/_index.md +++ b/exampleSite/content/_layout/sidebar-after/_index.md @@ -1,7 +1,7 @@ --- -title: Sidebar after -date: 2020-08-20T11:07:48.092Z +date: "2020-08-20T11:07:48.092Z" description: Sidebar after +title: Sidebar after --- <center> diff --git a/exampleSite/content/_layout/sidebar-before/_index.md b/exampleSite/content/_layout/sidebar-before/_index.md index 31b3bbd..c3223ae 100644 --- a/exampleSite/content/_layout/sidebar-before/_index.md +++ b/exampleSite/content/_layout/sidebar-before/_index.md @@ -1,7 +1,7 @@ --- -title: Sidebar before -date: 2020-08-20T11:08:17.209Z +date: "2020-08-20T11:08:17.209Z" description: Sidebar before +title: Sidebar before --- [//]: # (This a comment) diff --git a/exampleSite/content/content-and-customization/00-adding-content/_index.md b/exampleSite/content/content-and-customization/00-adding-content/_index.md index ed9e11b..cbe1097 100644 --- a/exampleSite/content/content-and-customization/00-adding-content/_index.md +++ b/exampleSite/content/content-and-customization/00-adding-content/_index.md @@ -1,20 +1,20 @@ --- -lastmodifierdisplayname: Valere JEANTET -title: Adding content -description: This page tells you how to use the theme to add and structure your - site content. -date: 2020-09-08T22:49:36.481Z -head: "" creatordisplayname: Valere JEANTET -weight: 1 +creatoremail: valere.jeantet@gmail.com +date: "2020-09-08T22:49:36.481Z" +description: This page tells you how to use the theme to add and structure your site + content. +head: "" hidden: false -pre: "" -layout: "" +lastmodifierdisplayname: Valere JEANTET lastmodifieremail: valere.jeantet@gmail.com -creatoremail: valere.jeantet@gmail.com +layout: "" +pre: "" tags: - - tag1 - - tag2 +- tag1 +- tag2 +title: Adding content +weight: 1 --- {{% notice %}}This page tells you how to use the theme to add and structure your site content.{{% /notice %}} diff --git a/exampleSite/content/content-and-customization/00-adding-content/myslide/index.md b/exampleSite/content/content-and-customization/00-adding-content/myslide/index.md index 1f611bc..08f1544 100644 --- a/exampleSite/content/content-and-customization/00-adding-content/myslide/index.md +++ b/exampleSite/content/content-and-customization/00-adding-content/myslide/index.md @@ -1,17 +1,16 @@ -+++ -title = "My Slide ! fullscreen" -date = "2017-04-24T18:36:24+02:00" -type="slide" -hidden=true - -theme = "league" -[revealOptions] -transition= 'concave' -controls= true -progress= true -history= false -center= true -+++ +--- +date: "2017-04-24T18:36:24+02:00" +hidden: true +revealOptions: + center: true + controls: true + history: false + progress: true + transition: concave +theme: league +title: My Slide ! fullscreen +type: slide +--- # In the morning diff --git a/exampleSite/content/content-and-customization/00-adding-content/page-images/_index.md b/exampleSite/content/content-and-customization/00-adding-content/page-images/_index.md index 3100ffb..0b6eacc 100644 --- a/exampleSite/content/content-and-customization/00-adding-content/page-images/_index.md +++ b/exampleSite/content/content-and-customization/00-adding-content/page-images/_index.md @@ -1,10 +1,10 @@ -+++ -title = "images" -date = "2017-04-24T18:36:24+02:00" -weight = 10 -hidden = false -subpage = true -+++ +--- +date: "2017-04-24T18:36:24+02:00" +hidden: false +subpage: true +title: images +weight: 10 +--- Images have a similar syntax to markdown links but include a preceding exclamation point. ``` diff --git a/exampleSite/content/content-and-customization/00-adding-content/page-slide/_index.md b/exampleSite/content/content-and-customization/00-adding-content/page-slide/_index.md index 9924552..c5f2df6 100644 --- a/exampleSite/content/content-and-customization/00-adding-content/page-slide/_index.md +++ b/exampleSite/content/content-and-customization/00-adding-content/page-slide/_index.md @@ -1,10 +1,9 @@ -+++ -title = "As a SlideDeck" -description = "" -date = "2017-04-24T18:36:24+02:00" -weight = 90 - -+++ +--- +date: "2017-04-24T18:36:24+02:00" +description: "" +title: As a SlideDeck +weight: 90 +--- A basic .md file can be rendered as a reveal.js presentation full screen. diff --git a/exampleSite/content/content-and-customization/01-homepage/_index.md b/exampleSite/content/content-and-customization/01-homepage/_index.md index 6cd1951..346ab25 100644 --- a/exampleSite/content/content-and-customization/01-homepage/_index.md +++ b/exampleSite/content/content-and-customization/01-homepage/_index.md @@ -1,8 +1,8 @@ -+++ -title="Home page" -description = "Control how the home page should be rendered" -weight=10 -+++ +--- +description: Control how the home page should be rendered +title: Home page +weight: 10 +--- {{% alert theme="success" %}}By default, this theme use the first section (folder) available in your content folder as a homepage.{{%/alert%}} diff --git a/exampleSite/content/content-and-customization/02-navigation-search/_index.md b/exampleSite/content/content-and-customization/02-navigation-search/_index.md index 2274dd5..7e565ed 100644 --- a/exampleSite/content/content-and-customization/02-navigation-search/_index.md +++ b/exampleSite/content/content-and-customization/02-navigation-search/_index.md @@ -1,9 +1,9 @@ -+++ -title = "Navigation & Search" -description = "" -weight = 30 -hide = "toc" -+++ +--- +description: "" +hide: toc +title: Navigation & Search +weight: 30 +--- Docport allow you to easily customize header, left & righ sidebars and footer. diff --git a/exampleSite/content/content-and-customization/02-navigation-search/menu/_index.md b/exampleSite/content/content-and-customization/02-navigation-search/menu/_index.md index 4a38d9a..2e1a91a 100644 --- a/exampleSite/content/content-and-customization/02-navigation-search/menu/_index.md +++ b/exampleSite/content/content-and-customization/02-navigation-search/menu/_index.md @@ -1,9 +1,8 @@ -+++ -title = "Menu" -description = "" -weight = 20 - -+++ +--- +description: "" +title: Menu +weight: 20 +--- Docport's Menu displays your content structure on left. diff --git a/exampleSite/content/content-and-customization/02-navigation-search/search/_index.md b/exampleSite/content/content-and-customization/02-navigation-search/search/_index.md index 0ac33e0..a455ce0 100644 --- a/exampleSite/content/content-and-customization/02-navigation-search/search/_index.md +++ b/exampleSite/content/content-and-customization/02-navigation-search/search/_index.md @@ -1,9 +1,9 @@ --- -title: Search Engine +date: "2020-08-20T16:31:33.621Z" description: search engine -weight: 400 -date: 2020-08-20T16:31:33.621Z post: "" +title: Search Engine +weight: 400 --- diff --git a/exampleSite/content/content-and-customization/02-navigation-search/thefooter/_index.md b/exampleSite/content/content-and-customization/02-navigation-search/thefooter/_index.md index b4bca90..2448640 100644 --- a/exampleSite/content/content-and-customization/02-navigation-search/thefooter/_index.md +++ b/exampleSite/content/content-and-customization/02-navigation-search/thefooter/_index.md @@ -1,9 +1,8 @@ -+++ -title = "Footer" -description = "" -weight = 100 - -+++ +--- +description: "" +title: Footer +weight: 100 +--- Docport's Footer displays what you want ! diff --git a/exampleSite/content/content-and-customization/02-navigation-search/theheader/_index.md b/exampleSite/content/content-and-customization/02-navigation-search/theheader/_index.md index 0ab6123..2490ecf 100644 --- a/exampleSite/content/content-and-customization/02-navigation-search/theheader/_index.md +++ b/exampleSite/content/content-and-customization/02-navigation-search/theheader/_index.md @@ -1,9 +1,8 @@ -+++ -title = "Header" -description = "" -weight = 10 - -+++ +--- +description: "" +title: Header +weight: 10 +--- Docport's Header displays Site Title and Site shortcuts. diff --git a/exampleSite/content/content-and-customization/02-navigation-search/toc/_index.md b/exampleSite/content/content-and-customization/02-navigation-search/toc/_index.md index d87edd0..f1fdae3 100644 --- a/exampleSite/content/content-and-customization/02-navigation-search/toc/_index.md +++ b/exampleSite/content/content-and-customization/02-navigation-search/toc/_index.md @@ -1,9 +1,8 @@ -+++ -title = "Content right bar" -description = "" -weight = 50 - -+++ +--- +description: "" +title: Content right bar +weight: 50 +--- With each page, a sidebar is displayed on the right side, with the current table of content. * the 2 dashed rectangles are 2 position where you can inject custom content, see bellow diff --git a/exampleSite/content/content-and-customization/03-look-and-feel/_index.md b/exampleSite/content/content-and-customization/03-look-and-feel/_index.md index f24e021..5882e24 100644 --- a/exampleSite/content/content-and-customization/03-look-and-feel/_index.md +++ b/exampleSite/content/content-and-customization/03-look-and-feel/_index.md @@ -1,8 +1,8 @@ -+++ -title = "Look and feel" -Weight=40 -hide = "toc" -+++ +--- +Weight: 40 +hide: toc +title: Look and feel +--- You can change the style and behavior of the theme without touching its source code. * Change base colors diff --git a/exampleSite/content/content-and-customization/03-look-and-feel/colors/_index.md b/exampleSite/content/content-and-customization/03-look-and-feel/colors/_index.md index 171fd8b..eef7867 100644 --- a/exampleSite/content/content-and-customization/03-look-and-feel/colors/_index.md +++ b/exampleSite/content/content-and-customization/03-look-and-feel/colors/_index.md @@ -1,8 +1,7 @@ -+++ -title="Colors" -subpage=true - -+++ +--- +subpage: true +title: Colors +--- By default, a site using docPort has the theme’s default color.\ However, if you want your own color scheme (and you probably will!) you can very easily override the theme defaults with your own project-specific values - Hugo will look in your project files first when looking for information to build your site. diff --git a/exampleSite/content/content-and-customization/03-look-and-feel/css-js/_index.md b/exampleSite/content/content-and-customization/03-look-and-feel/css-js/_index.md index 52d4aed..8704285 100644 --- a/exampleSite/content/content-and-customization/03-look-and-feel/css-js/_index.md +++ b/exampleSite/content/content-and-customization/03-look-and-feel/css-js/_index.md @@ -1,8 +1,7 @@ -+++ -title="CSS & JS" -subpage=true - -+++ +--- +subpage: true +title: CSS & JS +--- ## Add custom CSS and JS into the \<head\> part of each page : diff --git a/exampleSite/content/content-and-customization/03-look-and-feel/disable/_index.md b/exampleSite/content/content-and-customization/03-look-and-feel/disable/_index.md index b35401f..a46790a 100644 --- a/exampleSite/content/content-and-customization/03-look-and-feel/disable/_index.md +++ b/exampleSite/content/content-and-customization/03-look-and-feel/disable/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Disable features" -subpage=true -+++ +--- +subpage: true +title: Disable features +--- You can disable feature in docport by changing some params in `config.toml` diff --git a/exampleSite/content/content-and-customization/04-shortcodes/_index.md b/exampleSite/content/content-and-customization/04-shortcodes/_index.md index bce46b5..b56611e 100644 --- a/exampleSite/content/content-and-customization/04-shortcodes/_index.md +++ b/exampleSite/content/content-and-customization/04-shortcodes/_index.md @@ -1,9 +1,9 @@ -+++ -title = "Shortcodes" -description = "Use DocPort Hugo shortcodes to quickly build site pages." -weight = 50 -redirect = "shortcodes" -+++ +--- +description: Use DocPort Hugo shortcodes to quickly build site pages. +redirect: shortcodes +title: Shortcodes +weight: 50 +--- diff --git a/exampleSite/content/content-and-customization/_index.md b/exampleSite/content/content-and-customization/_index.md index 60a49f8..d693dbd 100644 --- a/exampleSite/content/content-and-customization/_index.md +++ b/exampleSite/content/content-and-customization/_index.md @@ -1,8 +1,8 @@ -+++ -title = "Content and Customization" -description = "" -weight = 30 -hide = "toc" -+++ +--- +description: "" +hide: toc +title: Content and Customization +weight: 30 +--- {{%children style="h2" description="true" %}} diff --git a/exampleSite/content/docport-theme/_index.md b/exampleSite/content/docport-theme/_index.md index 78f89d2..da0b62e 100644 --- a/exampleSite/content/docport-theme/_index.md +++ b/exampleSite/content/docport-theme/_index.md @@ -1,7 +1,7 @@ --- -title: DocPort Theme for Hugo +date: "2020-09-08T22:11:57.883Z" description: first page -date: 2020-09-08T22:11:57.883Z +title: DocPort Theme for Hugo weight: 1 --- [DocPort](https://github.com/vjeantet/hugo-theme-docport), a professional documentation theme built for Hugo. \ diff --git a/exampleSite/content/docport-theme/credits/_index.md b/exampleSite/content/docport-theme/credits/_index.md index e2df920..087538c 100644 --- a/exampleSite/content/docport-theme/credits/_index.md +++ b/exampleSite/content/docport-theme/credits/_index.md @@ -1,9 +1,9 @@ -+++ -title = "Credits" -description = "Contributors and packages used by hugo-theme-docport" -subpage = true -hide = "toc" -+++ +--- +description: Contributors and packages used by hugo-theme-docport +hide: toc +subpage: true +title: Credits +--- ## Contributors diff --git a/exampleSite/content/examples/_index.md b/exampleSite/content/examples/_index.md index fe78245..5b0afc7 100644 --- a/exampleSite/content/examples/_index.md +++ b/exampleSite/content/examples/_index.md @@ -1,7 +1,7 @@ --- +hide: toc title: Examples weight: 50 -hide: toc --- some examples diff --git a/exampleSite/content/examples/page with raw content/_index.md b/exampleSite/content/examples/page with raw content/_index.md index c1a5021..6fd9586 100644 --- a/exampleSite/content/examples/page with raw content/_index.md +++ b/exampleSite/content/examples/page with raw content/_index.md @@ -1,7 +1,7 @@ --- -title: A page with raw content -render: raw description: Nothing but your content ! usefull for special pages +render: raw +title: A page with raw content weight: 99 --- <head> diff --git a/exampleSite/content/examples/page without footer/_index.md b/exampleSite/content/examples/page without footer/_index.md index b224304..f9ba13c 100644 --- a/exampleSite/content/examples/page without footer/_index.md +++ b/exampleSite/content/examples/page without footer/_index.md @@ -1,7 +1,7 @@ --- +hide: footer title: A page without footer weight: 20 -hide: footer --- diff --git a/exampleSite/content/examples/page without header/_index.md b/exampleSite/content/examples/page without header/_index.md index eb124d9..9c072c5 100644 --- a/exampleSite/content/examples/page without header/_index.md +++ b/exampleSite/content/examples/page without header/_index.md @@ -1,8 +1,7 @@ --- +hide: header title: A page without header weight: 10 -hide: header - --- {{%panel header="page's frontmatter"%}} ```yaml diff --git a/exampleSite/content/examples/page without next page/_index.md b/exampleSite/content/examples/page without next page/_index.md index 563406e..7a88cf2 100644 --- a/exampleSite/content/examples/page without next page/_index.md +++ b/exampleSite/content/examples/page without next page/_index.md @@ -1,8 +1,8 @@ --- -title: A page without "NEXT PAGE" description: hide everything -weight: 80 hide: nextpage +title: A page without "NEXT PAGE" +weight: 80 --- Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, diff --git a/exampleSite/content/examples/page without sidebar and toc/_index.md b/exampleSite/content/examples/page without sidebar and toc/_index.md index cd8fe8c..a59339c 100644 --- a/exampleSite/content/examples/page without sidebar and toc/_index.md +++ b/exampleSite/content/examples/page without sidebar and toc/_index.md @@ -1,7 +1,7 @@ --- +hide: toc, nav title: A page without sidebar and toc weight: 20 -hide: toc, nav --- {{%panel header="page's frontmatter"%}} diff --git a/exampleSite/content/examples/page without toc/_index.md b/exampleSite/content/examples/page without toc/_index.md index 3483ac1..e5caf30 100644 --- a/exampleSite/content/examples/page without toc/_index.md +++ b/exampleSite/content/examples/page without toc/_index.md @@ -1,7 +1,7 @@ --- +hide: toc title: A page without table of contents weight: 20 -hide: toc --- {{%panel header="page's frontmatter"%}} diff --git a/exampleSite/content/examples/page-without-any/_index.md b/exampleSite/content/examples/page-without-any/_index.md index 3af6a82..19210db 100644 --- a/exampleSite/content/examples/page-without-any/_index.md +++ b/exampleSite/content/examples/page-without-any/_index.md @@ -1,16 +1,12 @@ --- -title: A page with only TOC and next page description: hide everything +hide: +- header +- nav +- breadcrumb +- footer +title: A page with only TOC and next page weight: 90 - - -hide: - - header - - nav - - breadcrumb - - footer - - --- Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, diff --git a/exampleSite/content/getting-start/_index.md b/exampleSite/content/getting-start/_index.md index a48db43..9a3c6fb 100644 --- a/exampleSite/content/getting-start/_index.md +++ b/exampleSite/content/getting-start/_index.md @@ -1,13 +1,13 @@ --- -post: " 👋" -title: Getting started +alwaysopen: true +date: "2020-08-20T16:42:11.812Z" description: Getting started -date: 2020-08-20T16:42:11.812Z -weight: 2 head: <hr/> -alwaysopen: true hide: - - toc +- toc +post: " \U0001F44B" +title: Getting started +weight: 2 --- ## Requirements diff --git a/exampleSite/content/getting-start/configuration/_index.md b/exampleSite/content/getting-start/configuration/_index.md index 0e7588b..c1ce77f 100644 --- a/exampleSite/content/getting-start/configuration/_index.md +++ b/exampleSite/content/getting-start/configuration/_index.md @@ -1,8 +1,8 @@ -+++ -title = "Configuration" -description = "" -weight = 2 -+++ +--- +description: "" +title: Configuration +weight: 2 +--- There are a few configuration options that you can add to your `config.toml` file. diff --git a/exampleSite/content/getting-start/installation/As-git-clone/_index.md b/exampleSite/content/getting-start/installation/As-git-clone/_index.md index ddcec2d..f61f74c 100644 --- a/exampleSite/content/getting-start/installation/As-git-clone/_index.md +++ b/exampleSite/content/getting-start/installation/As-git-clone/_index.md @@ -1,9 +1,9 @@ -+++ -title = "with git clone" -description = "" -subpage = true -weight = 1 -+++ +--- +description: "" +subpage: true +title: with git clone +weight: 1 +--- ## Install DocPort with a git clone diff --git a/exampleSite/content/getting-start/installation/_index.md b/exampleSite/content/getting-start/installation/_index.md index 33cc35b..ac84721 100644 --- a/exampleSite/content/getting-start/installation/_index.md +++ b/exampleSite/content/getting-start/installation/_index.md @@ -1,9 +1,8 @@ -+++ -title = "Installation" -description = "" -weight = 1 - -+++ +--- +description: "" +title: Installation +weight: 1 +--- {{% alert theme="warning" %}}HUGO **v0.50** minimum required to use this theme (prefer extended version if you want to modify this theme source{{%/alert%}} diff --git a/exampleSite/content/getting-start/installation/direct copy/_index.md b/exampleSite/content/getting-start/installation/direct copy/_index.md index e154958..f962d2e 100644 --- a/exampleSite/content/getting-start/installation/direct copy/_index.md +++ b/exampleSite/content/getting-start/installation/direct copy/_index.md @@ -1,9 +1,9 @@ -+++ -title = "from zip archive" -description = "" -weight = 1 -subpage = true -+++ +--- +description: "" +subpage: true +title: from zip archive +weight: 1 +--- ## Install DocPort from a zip archive diff --git a/exampleSite/content/shortcodes/_index.md b/exampleSite/content/shortcodes/_index.md index 8d82c46..fe708bb 100644 --- a/exampleSite/content/shortcodes/_index.md +++ b/exampleSite/content/shortcodes/_index.md @@ -1,10 +1,11 @@ -+++ -title = "Shortcodes" -description = "" -date = "2017-04-24T18:36:24+02:00" -weight = 30 -hide = ["toc"] -+++ +--- +date: "2017-04-24T18:36:24+02:00" +description: "" +hide: +- toc +title: Shortcodes +weight: 30 +--- A bunch of Shortcodes are available with this theme : diff --git a/exampleSite/content/shortcodes/alert/_index.md b/exampleSite/content/shortcodes/alert/_index.md index 1a3e217..56dc667 100644 --- a/exampleSite/content/shortcodes/alert/_index.md +++ b/exampleSite/content/shortcodes/alert/_index.md @@ -1,7 +1,7 @@ -+++ -title = "alert" -description = "The alert shortcode allows you to highlight information in your page." -+++ +--- +description: The alert shortcode allows you to highlight information in your page. +title: alert +--- The `alert` shortcode allow you to highlight information in your page. They create a colored box surrounding your text, like this: diff --git a/exampleSite/content/shortcodes/attachments/_index.md b/exampleSite/content/shortcodes/attachments/_index.md index 6d34496..a2d113c 100644 --- a/exampleSite/content/shortcodes/attachments/_index.md +++ b/exampleSite/content/shortcodes/attachments/_index.md @@ -1,7 +1,7 @@ -+++ -title = "attachments" -description = "The Attachments shortcode displays a list of files attached to a page." -+++ +--- +description: The Attachments shortcode displays a list of files attached to a page. +title: attachments +--- The Attachments shortcode displays a list of files attached to a page. Example : diff --git a/exampleSite/content/shortcodes/button/_index.md b/exampleSite/content/shortcodes/button/_index.md index 23d2941..f908e9c 100644 --- a/exampleSite/content/shortcodes/button/_index.md +++ b/exampleSite/content/shortcodes/button/_index.md @@ -1,7 +1,7 @@ -+++ -title = "button" -description = "Display an actionable button in your page." -+++ +--- +description: Display an actionable button in your page. +title: button +--- Display an actionable button in your page. diff --git a/exampleSite/content/shortcodes/children/_index.md b/exampleSite/content/shortcodes/children/_index.md index cf5df4b..6d253e7 100644 --- a/exampleSite/content/shortcodes/children/_index.md +++ b/exampleSite/content/shortcodes/children/_index.md @@ -1,7 +1,7 @@ -+++ -title = "children" -description = "List the child pages of a page" -+++ +--- +description: List the child pages of a page +title: children +--- Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages. diff --git a/exampleSite/content/shortcodes/children/children-1/_index.md b/exampleSite/content/shortcodes/children/children-1/_index.md index d0c5179..6810320 100644 --- a/exampleSite/content/shortcodes/children/children-1/_index.md +++ b/exampleSite/content/shortcodes/children/children-1/_index.md @@ -1,6 +1,6 @@ -+++ -title = "page 1" -description = "This is a demo child page" -+++ +--- +description: This is a demo child page +title: page 1 +--- This is a demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.md index d6373ba..4ca97aa 100644 --- a/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.md +++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.md @@ -1,6 +1,6 @@ -+++ -title = "page 1-1" -description = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod" -+++ +--- +description: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod +title: page 1-1 +--- This is a demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.md index 5ce56f4..b73ac22 100644 --- a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.md +++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.md @@ -1,6 +1,6 @@ -+++ -title = "page 1-1-1" -description = "This is a demo child page" -+++ +--- +description: This is a demo child page +title: page 1-1-1 +--- This is a demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.md index d5d9ab2..3ae96ee 100644 --- a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.md +++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.md @@ -1,6 +1,6 @@ -+++ -title = "page 1-1-1-1" -description = "This is a demo child page" -+++ +--- +description: This is a demo child page +title: page 1-1-1-1 +--- This is a demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.md b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.md index 883b5b2..62a93db 100644 --- a/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.md +++ b/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.md @@ -1,6 +1,6 @@ -+++ -title = "page 1-1-1-1-1" -description = "This is a demo child page" -+++ +--- +description: This is a demo child page +title: page 1-1-1-1-1 +--- This is a demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-2/_index.md b/exampleSite/content/shortcodes/children/children-2/_index.md index a96140c..db3512d 100644 --- a/exampleSite/content/shortcodes/children/children-2/_index.md +++ b/exampleSite/content/shortcodes/children/children-2/_index.md @@ -1,7 +1,7 @@ -+++ -title = "page 2" -description = "" -+++ +--- +description: "" +title: page 2 +--- Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, diff --git a/exampleSite/content/shortcodes/children/children-2/test3.md b/exampleSite/content/shortcodes/children/children-2/test3.md index f603d4c..3556c79 100644 --- a/exampleSite/content/shortcodes/children/children-2/test3.md +++ b/exampleSite/content/shortcodes/children/children-2/test3.md @@ -1,6 +1,6 @@ -+++ -title = "page test 3" -description = "This is a page test" -+++ +--- +description: This is a page test +title: page test 3 +--- This is a test 3 demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-3/_index.md b/exampleSite/content/shortcodes/children/children-3/_index.md index 4e3d423..06e0205 100644 --- a/exampleSite/content/shortcodes/children/children-3/_index.md +++ b/exampleSite/content/shortcodes/children/children-3/_index.md @@ -1,6 +1,6 @@ -+++ -title = "page 3" -description = "This is a demo child page" -+++ +--- +description: This is a demo child page +title: page 3 +--- This is a demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/children-4/_index.md b/exampleSite/content/shortcodes/children/children-4/_index.md index 26e88f7..8dcb5db 100644 --- a/exampleSite/content/shortcodes/children/children-4/_index.md +++ b/exampleSite/content/shortcodes/children/children-4/_index.md @@ -1,7 +1,7 @@ -+++ -title = "page 4" -description = "This is a demo child page" -hidden=true -+++ +--- +description: This is a demo child page +hidden: true +title: page 4 +--- This is a demo child page, not displayed in the menu
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/children/test.md b/exampleSite/content/shortcodes/children/test.md index 7273459..7d8d413 100644 --- a/exampleSite/content/shortcodes/children/test.md +++ b/exampleSite/content/shortcodes/children/test.md @@ -1,6 +1,6 @@ -+++ -title = "page test" -description = "This is a page test" -+++ +--- +description: This is a page test +title: page test +--- This is a test demo child page
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/columns/_index.md b/exampleSite/content/shortcodes/columns/_index.md index 2153bb2..eb0640d 100644 --- a/exampleSite/content/shortcodes/columns/_index.md +++ b/exampleSite/content/shortcodes/columns/_index.md @@ -1,7 +1,7 @@ -+++ -title = "columns" -description = "display elements side by side" -+++ +--- +description: display elements side by side +title: columns +--- the `{{</*column*/>}}` shortcode display content side by side diff --git a/exampleSite/content/shortcodes/excerpt-include/_index.md b/exampleSite/content/shortcodes/excerpt-include/_index.md index 0f7ccc9..8eeb735 100644 --- a/exampleSite/content/shortcodes/excerpt-include/_index.md +++ b/exampleSite/content/shortcodes/excerpt-include/_index.md @@ -1,7 +1,8 @@ -+++ -title = "excerpt-include" -description = "The Excerpt Include shortcode is used to display ‘excerpted’ (that is, a segment of) content from one page in another." -+++ +--- +description: The Excerpt Include shortcode is used to display ‘excerpted’ (that is, + a segment of) content from one page in another. +title: excerpt-include +--- The Excerpt Include shortcode is used to display 'excerpted' (that is, a segment of) content from one page in another. Before you can use this shortcode, the excerpt must have been defined using the Excerpt shortcode. {{%alert info%}}Note that you can have more than one Excerpt Include shortcode on a page (although you can have only one Excerpt shortcode on a page).{{%/alert%}} diff --git a/exampleSite/content/shortcodes/excerpt/_index.md b/exampleSite/content/shortcodes/excerpt/_index.md index 5878c55..9679570 100644 --- a/exampleSite/content/shortcodes/excerpt/_index.md +++ b/exampleSite/content/shortcodes/excerpt/_index.md @@ -1,7 +1,8 @@ -+++ -title = "excerpt" -description = "The Excerpt shortcode is used to mark a part of a page's content for re-use." -+++ +--- +description: The Excerpt shortcode is used to mark a part of a page's content for + re-use. +title: excerpt +--- The Excerpt shortcode is used to mark a part of a page's content for re-use. Defining an excerpt enables other shortcodes, such as the excerpt-include shortcode, to display the marked content elsewhere. diff --git a/exampleSite/content/shortcodes/expand/_index.md b/exampleSite/content/shortcodes/expand/_index.md index 17100d8..82c1319 100644 --- a/exampleSite/content/shortcodes/expand/_index.md +++ b/exampleSite/content/shortcodes/expand/_index.md @@ -1,7 +1,7 @@ -+++ -title = "expand" -description = "Displays an expandable/collapsible section of text on your page" -+++ +--- +description: Displays an expandable/collapsible section of text on your page +title: expand +--- The Expand shortcode displays an expandable/collapsible section of text on your page. Here is an example diff --git a/exampleSite/content/shortcodes/icon/_index.md b/exampleSite/content/shortcodes/icon/_index.md index 921fd90..fdc1f2b 100644 --- a/exampleSite/content/shortcodes/icon/_index.md +++ b/exampleSite/content/shortcodes/icon/_index.md @@ -1,8 +1,8 @@ -+++ -title = "icon" -description = "Display an icon." -date = 2020-09-08T20:40:23.389Z -+++ +--- +date: "2020-09-08T20:40:23Z" +description: Display an icon. +title: icon +--- Display one of the 2 298 icons like {{% icon name="fa-address-card" size="64px" %}} diff --git a/exampleSite/content/shortcodes/mermaid/_index.md b/exampleSite/content/shortcodes/mermaid/_index.md index 5de970a..a106d0c 100644 --- a/exampleSite/content/shortcodes/mermaid/_index.md +++ b/exampleSite/content/shortcodes/mermaid/_index.md @@ -1,7 +1,8 @@ -+++ -title = "mermaid" -description = "Mermaid is a tool that generates diagrams and charts, from markdown-inspired text definitions" -+++ +--- +description: Mermaid is a tool that generates diagrams and charts, from markdown-inspired + text definitions +title: mermaid +--- ## Flowchart example {{%expand "Show code ..."%}} diff --git a/exampleSite/content/shortcodes/notice/_index.md b/exampleSite/content/shortcodes/notice/_index.md index bca8795..1b90daa 100644 --- a/exampleSite/content/shortcodes/notice/_index.md +++ b/exampleSite/content/shortcodes/notice/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Notice" -description = "Disclaimers to help you structure your page" -+++ +--- +description: Disclaimers to help you structure your page +title: Notice +--- {{% notice primary summary %}} The **notice** shortcode highlights a text with a solid vertical line in front of your text. diff --git a/exampleSite/content/shortcodes/panel/_index.md b/exampleSite/content/shortcodes/panel/_index.md index 7ddc5bf..a390794 100644 --- a/exampleSite/content/shortcodes/panel/_index.md +++ b/exampleSite/content/shortcodes/panel/_index.md @@ -1,7 +1,7 @@ -+++ -title = "panel" -description = "Allow you to highlight information or put it in a box." -+++ +--- +description: Allow you to highlight information or put it in a box. +title: panel +--- diff --git a/exampleSite/content/shortcodes/revealjs/_index.md b/exampleSite/content/shortcodes/revealjs/_index.md index eace9fd..0925444 100644 --- a/exampleSite/content/shortcodes/revealjs/_index.md +++ b/exampleSite/content/shortcodes/revealjs/_index.md @@ -1,8 +1,8 @@ -+++ -title = "revealjs" -slug = "revealjs" -description = "present content as a reveal.js slide" -+++ +--- +description: present content as a reveal.js slide +slug: revealjs +title: revealjs +--- This shortcode will format the enclosed markdow to render it with [reveal.js](http://lab.hakim.se/reveal-js/) at runtime (client-side) diff --git a/exampleSite/content/shortcodes/tabs/_index.md b/exampleSite/content/shortcodes/tabs/_index.md index 166bb13..3138446 100644 --- a/exampleSite/content/shortcodes/tabs/_index.md +++ b/exampleSite/content/shortcodes/tabs/_index.md @@ -1,7 +1,7 @@ -+++ -title = "tabs" -description = "Tabs let you organize content by context with multiple tab." -+++ +--- +description: Tabs let you organize content by context with multiple tab. +title: tabs +--- Tabs let you organize content by context with multiple tab, for example HelloWorld instructions for each language. |