Skip to content
Snippets Groups Projects
Commit 9cd0758c authored by David Rouquet's avatar David Rouquet
Browse files

replace content with submodule

parent c1e0cbdb
No related branches found
No related tags found
1 merge request!1Content in wiki
Pipeline #1987 passed
This commit is part of merge request !1. Comments created here will be created in the context of that merge request.
.gitmodules 0 → 100644
[submodule "content"]
path = content
url = https://gitlab.tetras-libre.fr/tetras-libre/tetras-page-doks.wiki.git
Subproject commit f4b18d218de55db4bf1f9c1bc2943bb923a60139
---
title : "Tetras Doks'"
description: ""
lead: "Welcome to Tetras Libre documentation !"
date: 2023-09-07T16:33:54+02:00
lastmod: 2023-09-07T16:33:54+02:00
draft: false
seo:
title: "Tetras Doks'" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
---
title : "Tetras Doc'"
description: ""
lead: "Bienvenue sur la documentation Tetras-libre ! "
date: 2023-09-07T16:33:54+02:00
lastmod: 2023-09-07T16:33:54+02:00
draft: false
seo:
title: "Tetras Doc'" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
---
title: "Blog"
description: ""
summary: ""
date: 2023-09-07T16:21:44+02:00
lastmod: 2023-09-07T16:21:44+02:00
draft: false
weight: 50
categories: []
tags: []
contributors: []
pinned: false
homepage: false
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
---
title: "Example Post"
description: "Just an example post."
summary: ""
date: 2023-09-07T16:27:22+02:00
lastmod: 2023-09-07T16:27:22+02:00
draft: false
weight: 50
categories: []
tags: []
contributors: []
pinned: false
homepage: false
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
---
title: "Adapt Tetras Doc' to your project"
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: 910
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
This documentation will guide you through setting up this template.
## Create Menu Item into Doc
### Main Menu Item
If you want to create new main menu Item as presented bellow follow those steps :
![img_2.png](img_2.png)
- Create a folder into `content/docs/`
- Create as many subfolder into `content/docs/NewMenuItem/` as you need
- Every subfoler must contain an `index.md` and a `content.md`
### Index.md
```
---
title: "My Title"
description: "This an optional description of the content"
summary: "This is optionnal"
date: date of today at format YYYY-MM-DDTHH:MM:SS+GMT
lastmod: date of modification at format YYYY-MM-DDTHH:MM:SS+GMT
draft: false
menu:
docs:
parent: ""
identifier: "reference-22e9ba8aefa7ef9891199cf8db3a08cd"
weight: 700 (Represent the order where your item will be on the menu)
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
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
````
---
title: "Set up"
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: 910
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
Your awesome content there
## Important Item of your content
### Less Important Item of your content
Oh what an awesome content !
````
- `title` 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)
This is useful to structure you text and easier for the user's navigation.
You can find more information there : [Doks Markdown Cheat Sheet](https://getdoks.org/docs/reference/markdown-basic-syntax/)
---
title: "Getting Started"
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: "Getting Started--sqleeezjaen"
weight: 900
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
This documentation will guide you through setting up this template.
## Set up the project
1. Clone the project with `git clone https://gitlab.tetras-libre.fr/tetras-libre/tetras-page-doks`
2. `cd tetras-page-doks`
3. `npm install`
4. `git remote set-url origin git://new.url.here` initialized your git repository
5. `npm run dev` to run the project locally
6. `npm run build`
7. commit your project and make sure `hugo_stats.json` is present on your repository
---
title: "Set your documentation's URL"
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: 910
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
## Set up you own Nav Bar
You have to change /config/_default/menus/menus.en.toml
````
# [[docs]]
# name = "Prologue"
# weight = 10
# identifier = "prologue"
# url = "/docs/prologue/"
# [[docs]]
# name = "Help"
# weight = 60
# identifier = "help"
# url = "/docs/help/"
# [[docs]]
# name = "Lorem"
# weight = 70
# identifier = "lorem"
# url = "/docs/lorem/"
[[guide]]
name = "Lorem"
weight = 10
identifier = "lorem"
url = "/guide/lorem/"
[[tutorial]]
name = "Lorem"
weight = 10
identifier = "lorem"
url = "/tutorial/lorem/"
[[main]]
name = "Docs"
url = "/docs/"
# url = "/docs/1.0/prologue/introduction/"
weight = 10
[[main]]
name = "Blog"
url = "/blog/set-up/getting-started/"
weight = 30
# [[social]]
# name = "Twitter"
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-x" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M4 4l11.733 16h4.267l-11.733 -16z"></path><path d="M4 20l6.768 -6.768m2.46 -2.46l6.772 -6.772"></path></svg>'
# url = "https://twitter.com/getdoks"
# weight = 10
#
# [[social]]
# name = "Discord"
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-discord" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M8 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M14 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M8.5 17c0 1 -1.356 3 -1.832 3c-1.429 0 -2.698 -1.667 -3.333 -3c-.635 -1.667 -.476 -5.833 1.428 -11.5c1.388 -1.015 2.782 -1.34 4.237 -1.5l.975 1.923a11.913 11.913 0 0 1 4.053 0l.972 -1.923c1.5 .16 3.043 .485 4.5 1.5c2 5.667 2.167 9.833 1.5 11.5c-.667 1.333 -2 3 -3.5 3c-.5 0 -2 -2 -2 -3"></path><path d="M7 16.5c3.5 1 6.5 1 10 0"></path></svg>'
# url = "https://getdoks.org/chat"
# weight = 20
[[social]]
name = "GitLab"
pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
url = "https://gitlab.tetras-libre.fr/explore"
post = "v0.1.0"
weight = 30
[[footer]]
name = "Privacy Policy"
url = "/privacy/"
weight = 10
# [[footer]]
# name = "Terms of Service"
# url = "/terms/"
# weight = 20
````
You must change the [[main]] section with you own url
---
title: "Set up"
description: ""
summary: ""
date: 2023-09-07T16:12:37+02:00
lastmod: 2023-09-07T16:12:37+02:00
draft: false
menu:
docs:
parent: ""
identifier: "Set up-2jjfjfljre"
weight: 700
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
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: "Docs"
description: ""
summary: ""
date: 2023-09-07T16:12:03+02:00
lastmod: 2023-09-07T16:12:03+02:00
draft: false
menu:
docs:
parent: ""
identifier: "docs-9602b15bad02600f3883f55e2ade6b81"
weight: 999
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
---
title: "Privacy Policy"
description: ""
summary: ""
date: 2023-09-07T17:19:07+02:00
lastmod: 2023-09-07T17:19:07+02:00
draft: false
type: "legal"
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment