diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml index 60e107354bddb66ed7790e70e444259074e2c706..f33d53ac73d69b86cbd5481f627841752df20663 100644 --- a/config/_default/menus/menus.en.toml +++ b/config/_default/menus/menus.en.toml @@ -30,7 +30,7 @@ [[main]] name = "Docs" - url = "/docs/" + url = "/docs/set-up/getting-started" # url = "/docs/1.0/prologue/introduction/" weight = 10 diff --git a/content/docs/Set up/SetUp.md b/content/docs/Set up/AdaptTetraDocToYou.md similarity index 96% rename from content/docs/Set up/SetUp.md rename to content/docs/Set up/AdaptTetraDocToYou.md index ca457a36bda300bad61516b8b3c06befe9e2dcf1..c104f113185f1bf3394a957c2072a67713f39a3f 100644 --- a/content/docs/Set up/SetUp.md +++ b/content/docs/Set up/AdaptTetraDocToYou.md @@ -1,5 +1,5 @@ --- -title: "Set up" +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 @@ -106,7 +106,7 @@ Your awesome content there Oh what an awesome content ! ```` -- `tile` will handle the name of the submenu on the left of this doc page : +- `title` will handle the name of the submenu on the left of this doc page :  diff --git a/content/docs/Set up/Getting-Started.md b/content/docs/Set up/Getting-Started.md new file mode 100644 index 0000000000000000000000000000000000000000..a4e1e814e26614bf0e2a4d71e2f266c86f004576 --- /dev/null +++ b/content/docs/Set up/Getting-Started.md @@ -0,0 +1,32 @@ +--- +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: "example-ee51430687e728ba6e68dea3359133ad" +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 to 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 + diff --git a/content/docs/Set up/SetUrl.md b/content/docs/Set up/SetUrl.md new file mode 100644 index 0000000000000000000000000000000000000000..7c03fe03a3bad334cdd99232167cec6ed8226b05 --- /dev/null +++ b/content/docs/Set up/SetUrl.md @@ -0,0 +1,96 @@ +--- +title: "Set Url of you Documentation" +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 diff --git a/hugo_stats.json b/hugo_stats.json index 304de97bd4a510d6b5025cda79e2be109ab6262c..43b68a6f2ebc8e2cb99a53e6604d75d22ea958a4 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -31,6 +31,7 @@ "meta", "nav", "noscript", + "ol", "p", "path", "pre", @@ -123,6 +124,8 @@ "home", "icon", "icon-tabler", + "icon-tabler-arrow-left", + "icon-tabler-arrow-right", "icon-tabler-brand-github", "icon-tabler-clock", "icon-tabler-dots-vertical", @@ -134,6 +137,7 @@ "img-fluid", "justify-content-between", "justify-content-center", + "justify-content-end", "justify-content-start", "lazyload", "lead", @@ -142,6 +146,7 @@ "list-inline-item", "list-unstyled", "list-view", + "m-2", "mb-0", "mb-1", "me-2", @@ -218,8 +223,10 @@ "tags", "taxonomy", "text-body", + "text-body-secondary", "text-center", "text-decoration-none", + "text-end", "text-lg-end", "text-lg-start", "text-muted", @@ -228,6 +235,7 @@ "title-submitted", "toc-mobile", "visually-hidden", + "w-100", "wrap" ], "ids": [ @@ -253,6 +261,8 @@ "searchToggleDesktop", "searchToggleMobile", "section-b191593bc602ff910417b3f85bb496ca", + "set-up-the-project", + "set-up-you-own-nav-bar", "socialMenu", "toc" ]