Skip to content

Commit

Permalink
docs: upgrade template to v7 (#421)
Browse files Browse the repository at this point in the history
* doc: add mascot

* upgrade theme to v7

* remove broken tags for now
  • Loading branch information
creativeprojects authored Oct 21, 2024
1 parent 2a34ea7 commit 24b2620
Show file tree
Hide file tree
Showing 25 changed files with 170 additions and 67 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- name: Setup Hugo
uses: peaceiris/actions-hugo@v3
with:
hugo-version: '0.135.0'
hugo-version: 'latest'
extended: true

- name: Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Setup Hugo
uses: peaceiris/actions-hugo@v3
with:
hugo-version: '0.135.0'
hugo-version: 'latest'
extended: true

- name: Build for GitHub Pages
Expand Down
1 change: 1 addition & 0 deletions docs/.frontmatter/database/pinnedItemsDb.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions docs/.frontmatter/database/taxonomyDb.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
2 changes: 2 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
archetype: "home"
title: resticprofile
description: Configuration profiles manager for restic backup
---

Configuration profiles manager for [restic backup](https://restic.net/)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/copy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Copy command"
tags: ["v0.18.0", "v0.26.0"]
# tags: ["v0.18.0", "v0.26.0"]
weight: 17
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/http_hooks.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "HTTP Hooks"
date: 2022-05-16T19:46:52+01:00
tags: ["v0.18.0"]
# tags: ["v0.18.0"]
weight: 22
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/include.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Includes"
date: 2022-05-02T20:00:00+02:00
tags: ["v0.18.0"]
# tags: ["v0.18.0"]
weight: 15
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/jsonschema/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "JSON schema"
date: 2022-04-24T09:44:47+01:00
tags: ["v0.21.0"]
# tags: ["v0.21.0"]
weight: 55
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Logs"
tags: ["v0.21.0"]
# tags: ["v0.21.0"]
weight: 45
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/priority.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Priority"
tags: ["v0.27.0"]
# tags: ["v0.27.0"]
weight: 35
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/sleep.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Preventing system sleep"
tags: ["v0.19.0"]
# tags: ["v0.19.0"]
weight: 40
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/configuration/v2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration v2 proposal"
tags: ["v1.0.0"]
# tags: ["v1.0.0"]
weight: 60
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/installation/binaries.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Pre-built binaries"
tags: ["v0.26.0"]
# tags: ["v0.26.0"]
weight: 5
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/installation/docker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Docker"
tags: ["v0.18.0"]
# tags: ["v0.18.0"]
date: 2022-04-23T23:58:56+01:00
weight: 30
---
Expand Down
2 changes: 1 addition & 1 deletion docs/content/schedules/commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Schedule Commands"
weight: 20
tags: ["v0.25.0", "v0.29.0"]
# tags: ["v0.25.0", "v0.29.0"]
---


Expand Down
2 changes: 1 addition & 1 deletion docs/content/schedules/non-root-schedule-in-container.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "User schedule in container"
weight: 150
tags: ["v0.27.0"]
# tags: ["v0.27.0"]
---


Expand Down
2 changes: 1 addition & 1 deletion docs/content/schedules/systemd.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Systemd"
weight: 105
tags: ["v0.25.0", "v0.29.0"]
# tags: ["v0.25.0", "v0.29.0"]
---


Expand Down
15 changes: 7 additions & 8 deletions docs/content/usage/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
+++
archetype = "chapter"
pre = "<b>3. </b>"
title = "Using resticprofile"
weight = 3
tags = ["v0.17.0"]
+++

---
archetype: "chapter"
pre: "<b>3. </b>"
title: "Using resticprofile"
weight: 3
# tags: ["v0.17.0"]
---

Here are a few examples how to run resticprofile (using the main example configuration file)

Expand Down
95 changes: 95 additions & 0 deletions docs/frontmatter.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"$schema": "https://frontmatter.codes/frontmatter.schema.json",
"frontMatter.taxonomy.contentTypes": [
{
"name": "default",
"pageBundle": false,
"previewPath": null,
"fields": [
{
"title": "Title",
"name": "title",
"type": "string"
},
{
"title": "Description",
"name": "description",
"type": "string"
},
{
"title": "Publishing date",
"name": "date",
"type": "datetime",
"default": "{{now}}",
"isPublishDate": true
},
{
"title": "Content preview",
"name": "preview",
"type": "image"
},
{
"title": "Is in draft",
"name": "draft",
"type": "draft"
},
{
"title": "Tags",
"name": "tags",
"type": "tags"
},
{
"title": "Categories",
"name": "categories",
"type": "categories"
},
{
"title": "Archetype",
"name": "archetype",
"type": "choice",
"choices": [
"default",
"home",
"chapter"
],
"default": "chapter"
},
{
"title": "Weight",
"name": "weight",
"type": "number",
"numberOptions": {
"min": 0,
"max": 1000,
"step": 1
}
},
{
"title": "Hidden",
"name": "hidden",
"type": "boolean"
},
{
"title": "pre",
"name": "pre",
"type": "string"
}
]
}
],
"frontMatter.framework.id": "hugo",
"frontMatter.content.publicFolder": "static",
"frontMatter.preview.host": "http://localhost:1313/resticprofile/",
"frontMatter.content.pageFolders": [
{
"title": "content",
"path": "[[workspace]]/content"
}
],
"frontMatter.git.enabled": true,
"frontMatter.git.submodule.folder": "themes",
"frontMatter.extends": [
"./themes/hugo-theme-relearn/vscode-frontmatter/snippets.en.json"
],
"frontMatter.snippets.wrapper.enabled": false
}
17 changes: 11 additions & 6 deletions docs/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,23 @@ publishdir = "../public/"

# For search functionality
[outputs]
home = [ "HTML", "RSS", "SEARCH", "SEARCHPAGE"]
home = [ "html", "rss" ]

[params]
themeVariant = [ "relearn-dark", "relearn-light" ]
# themeVariant = [ "relearn-dark", "relearn-light" ]
themeVariant = [
{ identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] },
{ identifier = 'relearn-light' },
{ identifier = 'relearn-dark' },
]
collapsibleMenu = true
externalLinkTarget = "_blank"
ordersectionsby = "weight"

[[menu.shortcuts]]
name = "<i class='fas fa-tags'></i> Tags"
url = "/tags"
weight = 10
# [[menu.shortcuts]]
# name = "<i class='fas fa-tags'></i> Tags"
# url = "/tags"
# weight = 10

[[menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
Expand Down
54 changes: 34 additions & 20 deletions docs/layouts/partials/logo.html
Original file line number Diff line number Diff line change
@@ -1,23 +1,37 @@
<style>
a#logo {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
font-size: 30px;
font-weight: 300;
margin-top: -13px;
text-transform: uppercase;
white-space: nowrap;
}
a#logo:hover {
color: #282828;
color: var(--MENU-SECTIONS-BG-color);
}
@media only all and (max-width: 59.938em) {
a#logo {
font-size: 25px;
margin-top: -3px;
}
a#R-logo {
display: flex;
align-items: center;
transition: opacity 0.3s ease;
}

a#R-logo img {
max-width: min(40%, 100px);
height: auto;
margin-right: 10px;
}

@media (max-width: 768px) {
a#R-logo img {
max-width: 30%;
}
}

a#R-logo span {
display: flex;
flex-direction: column;
color: inherit;
text-decoration: none;
}

a#R-logo .restic {
font-weight: bold;
}
</style>
<a id="logo" href="{{ .Site.Params.landingPageURL | default "/" | relLangURL }}">Resticprofile</a>
<a id="R-logo" class="R-default" href="{{ partial "permalink.gotmpl" (dict "to" .Site.Home) }}">
<img src="/images/logo.png" alt="ResticProfile Logo" />
<span>
<span class="restic">Restic</span>
<span class="profile">Profile</span>
</span>
</a>
20 changes: 3 additions & 17 deletions docs/layouts/partials/menu-footer.html
Original file line number Diff line number Diff line change
@@ -1,22 +1,8 @@
<style>
#footer {
font-size: 13px;
height: 100px;
margin-left: auto;
margin-right: auto;
padding: 2rem 1rem;
text-align: center;
min-width: 230px;
max-width: 300px;
}
#footer p {
margin: 0;
}
</style>

<!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/creativeprojects/resticprofile" data-size="large" data-show-count="true" aria-label="Star creativeprojects/resticprofile on GitHub">Star</a>
<a class="github-button" href="https://github.com/creativeprojects/resticprofile" data-color-scheme="no-preference: light; light: light; dark: dark_dimmed;" data-size="large" data-show-count="true" aria-label="Star creativeprojects/resticprofile on GitHub">Star</a>

<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>

<!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
Binary file added docs/static/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/themes/hugo-theme-relearn

0 comments on commit 24b2620

Please sign in to comment.