Skip to content
Snippets Groups Projects
Commit ed1fea59 authored by Antoine Roy's avatar Antoine Roy
Browse files

some tuto

parent a5738bcc
Branches
No related tags found
No related merge requests found
Pipeline #1593 passed
Showing with 68 additions and 14 deletions
...@@ -79,6 +79,9 @@ a{ ...@@ -79,6 +79,9 @@ a{
color: $tetra-green; color: $tetra-green;
} }
//image sizing
img.lazyautosizes{ img.lazyautosizes{
width: 100px; width: 200px;
object-fit: contain;
} }
...@@ -17,12 +17,14 @@ seo: ...@@ -17,12 +17,14 @@ seo:
canonical: "" # custom canonical URL (optional) canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true noindex: false # false (default) or true
--- ---
This Documentation will guide you to setting up this template. This Documentation will guide you to setting up this template.
## Create Menu Item into Doc ## Create Menu Item into Doc
### Main Menu Item
If you want to create new main menu Item as presented bellow follow those steps :
![Screen capture of the left nav menu](img.png) ![img_2.png](img_2.png)
- Create a folder into `content/docs/` - Create a folder into `content/docs/`
- Create as many subfolder into `content/docs/NewMenuItem/` as you need - Create as many subfolder into `content/docs/NewMenuItem/` as you need
...@@ -66,6 +68,12 @@ canonical: "" # custom canonical URL (optional) ...@@ -66,6 +68,12 @@ canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true noindex: false # false (default) or true
--- ---
``` ```
- `title` will handle the name of the main menu on the left of this doc page.
- `weight` will handle the order of the collapsable menu on the left of this doc page.
You can find more information there :
[Hugo CMS web site : _index.md section](https://gohugo.io/content-management/organization/#index-pages-_indexmd)
### content.md ### content.md
...@@ -98,8 +106,17 @@ Your awesome content there ...@@ -98,8 +106,17 @@ Your awesome content there
Oh what an awesome content ! Oh what an awesome content !
```` ````
Every Title in you markdown create an anchor link on the right of the doc part of the site. This is usefull to structure you text and for the user's navigation. - `tile` will handle the name of the submenu on the left of this doc page :
![img.png](img.png)
- `weight` will handle the order of the submenu
- Every part of you markdown content with at least two '#' will be concider as a title of type `<H2>` and create an anchor link on the right of this doc like this :
![img_1.png](img_1.png)
![alt=img_1](img_1.png) This is useful to structure you text and easier for the user's navigation.
<img src="./test-capture-ecran.png" alt='toto' width="200px"> You can find more information there : [Doks Markdown Cheat Sheet](https://getdoks.org/docs/reference/markdown-basic-syntax/)
...@@ -8,7 +8,7 @@ draft: false ...@@ -8,7 +8,7 @@ draft: false
menu: menu:
docs: docs:
parent: "" parent: ""
identifier: "reference-22e9ba8aefa7ef9891199cf8db3a08cd" identifier: "Set up-22e9ba8aefa7ef9891199cf8db3a08cd"
weight: 700 weight: 700
toc: true toc: true
seo: seo:
......
content/docs/Set up/img.png

5.68 KiB

content/docs/Set up/img_1.png

7.79 KiB

content/docs/Set up/img_2.png

2.75 KiB

---
title: "Second content"
description: "How to set up this Tetras Documentation Template."
summary: ""
date: 2023-09-07T16:13:18+02:00
lastmod: 2023-09-07T16:13:18+02:00
draft: false
menu:
docs:
parent: ""
identifier: "example-ee51430687e728ba6e68dea3359133ad"
weight: 920
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
ohlala totot
## oh bawi
sdsds
## lorel ipsum
toto
...@@ -17,3 +17,4 @@ seo: ...@@ -17,3 +17,4 @@ seo:
canonical: "" # custom canonical URL (optional) canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true noindex: false # false (default) or true
--- ---
content/docs/reference/img.png

6.01 KiB

content/docs/reference/img_1.png

7.74 KiB

...@@ -170,6 +170,7 @@ ...@@ -170,6 +170,7 @@
"mt-n3", "mt-n3",
"mx-2", "mx-2",
"mx-auto", "mx-auto",
"mx-xl-auto",
"my-3", "my-3",
"nav", "nav",
"nav-item", "nav-item",
...@@ -242,20 +243,21 @@ ...@@ -242,20 +243,21 @@
"TableOfContents", "TableOfContents",
"buttonColorMode", "buttonColorMode",
"contentmd", "contentmd",
"create-menu-item",
"create-menu-item-into-doc", "create-menu-item-into-doc",
"doks-docs-nav", "doks-docs-nav",
"first",
"first-step",
"further-reading", "further-reading",
"h-rh-i-0", "h-rh-i-0",
"h-rh-i-1", "h-rh-i-1",
"h-rh-i-2",
"indexmd", "indexmd",
"noindex-false--false-default-or-true", "lorel-ipsum",
"main-menu-item",
"my-second-big-title",
"offcanvasNavMain", "offcanvasNavMain",
"offcanvasNavMainLabel", "offcanvasNavMainLabel",
"offcanvasNavSection", "offcanvasNavSection",
"offcanvasNavSectionLabel", "offcanvasNavSectionLabel",
"oh-bawi",
"query", "query",
"search-form", "search-form",
"searchModal", "searchModal",
...@@ -265,8 +267,9 @@ ...@@ -265,8 +267,9 @@
"searchToggleMobile", "searchToggleMobile",
"section-0cbc6611f5540bd0809a388dc95a615b", "section-0cbc6611f5540bd0809a388dc95a615b",
"section-45389ee90014e0938cb09409b9a8794d", "section-45389ee90014e0938cb09409b9a8794d",
"section-63d5049791d9d79d86e9a108b0a999ca",
"section-b191593bc602ff910417b3f85bb496ca", "section-b191593bc602ff910417b3f85bb496ca",
"section-f71dbe52628a3f83a77ab494817525c6",
"set-up",
"socialMenu", "socialMenu",
"sous-titre-test", "sous-titre-test",
"titre-test", "titre-test",
......
...@@ -13659,6 +13659,7 @@ body { ...@@ -13659,6 +13659,7 @@ body {
color: #5a8264; } color: #5a8264; }
img.lazyautosizes { img.lazyautosizes {
width: 100px; } width: 200px;
object-fit: contain; }
/*# sourceMappingURL=main.css.map */ /*# sourceMappingURL=main.css.map */
\ No newline at end of file
{"Target":"main.8dc014666d552fcf56f654682996393698fbf1e2979c4942fbed2593b66e47b14e6df8e73d8860e0ff1b465ec04fc57d0817ef8f3540dc8e2db4c20d141b044a.css","MediaType":"text/css","Data":{"Integrity":"sha512-jcAUZm1VL89W9lRoKZY5Npj78eKXnElC++0lk7ZuR7FObfjnPYhg4P8bRl7AT8V9CBfvjzVA3I4ttMINFBsESg=="}} {"Target":"main.b94e19f9be222a7252272ee9a3c17d39f056d169030d4327c2dc366d267fed55bff427e5f41ed7cc56dcf7b0ae33ee6c3d1ecc6be878ed1995a6d9d9b0c42dbf.css","MediaType":"text/css","Data":{"Integrity":"sha512-uU4Z+b4iKnJSJy7po8F9OfBW0WkDDUMnwtw2bSZ/7VW/9Cfl9B7XzFbc97CuM+5sPR7Ma+h47RmVptnZsMQtvw=="}}
\ No newline at end of file \ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment