initial commit
This commit is contained in:
19
themes/hugo-theme-relearn/.editorconfig
Normal file
19
themes/hugo-theme-relearn/.editorconfig
Normal file
@@ -0,0 +1,19 @@
|
||||
# https://editorconfig.org
|
||||
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
max_line_length = 9999
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
charset = utf-8
|
||||
indent_size = 4
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = false
|
||||
56
themes/hugo-theme-relearn/.githooks/post-commit.py
Normal file
56
themes/hugo-theme-relearn/.githooks/post-commit.py
Normal file
@@ -0,0 +1,56 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
# This script appends the current commit hash to the version information in
|
||||
# `layouts/partials/version.txt`
|
||||
#
|
||||
# Call this script from your ".git/hooks/post-commit" file like this (supporting
|
||||
# Linux, Windows and MacOS)
|
||||
|
||||
# #!/bin/sh
|
||||
# python3 .githooks/post-commit.py
|
||||
|
||||
from datetime import datetime
|
||||
import os
|
||||
import re
|
||||
import subprocess
|
||||
|
||||
def main():
|
||||
script_name = "POST-COMMIT"
|
||||
script_dir = os.path.dirname(os.path.abspath(__file__))
|
||||
log_file = os.path.join(script_dir, "hooks.log")
|
||||
time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
|
||||
repo_root = subprocess.check_output(['git', 'rev-parse', '--show-toplevel'], universal_newlines=True).strip()
|
||||
repo_name = os.path.basename(repo_root)
|
||||
|
||||
file_path = 'layouts/partials/version.txt'
|
||||
with open(file_path, 'r+') as f:
|
||||
version = f.read().strip()
|
||||
new_version = ''
|
||||
match = re.match(r'(\d+\.\d+\.\d+)(?:\+([^+]+))?', version)
|
||||
if match:
|
||||
semver = match.group(1)
|
||||
old_hash = match.group(2)
|
||||
new_hash = subprocess.check_output(['git', 'rev-parse', 'HEAD~1']).decode('utf-8').strip()
|
||||
print(f'{time}: {repo_name} - {script_name} - old hash {old_hash} - new hash {new_hash}', file=open(log_file, "a"))
|
||||
print(f'{script_name} - old hash {old_hash} - new hash {new_hash}')
|
||||
if old_hash != new_hash:
|
||||
new_version = f'{semver}+{new_hash}'
|
||||
f.seek(0)
|
||||
f.write(new_version)
|
||||
f.truncate()
|
||||
f.close()
|
||||
subprocess.check_call(['git', 'add', file_path])
|
||||
subprocess.check_call(['git', 'commit', '--amend', '--no-edit'])
|
||||
else:
|
||||
print(f'{time}: {repo_name} - {script_name} - No change in hash, file {file_path} not updated', file=open(log_file, "a"))
|
||||
print(f'{script_name} - No change in hash, file {file_path} not updated')
|
||||
exit(0)
|
||||
else:
|
||||
print(f'{time}: {repo_name} - {script_name} - Invalid version format in {file_path}', file=open(log_file, "a"))
|
||||
print(f'{script_name} - Invalid version format in {file_path}')
|
||||
exit(1)
|
||||
print(f'{time}: {repo_name} - {script_name} - New version {new_version} was written to {file_path}', file=open(log_file, "a"))
|
||||
exit(0)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
49
themes/hugo-theme-relearn/.githooks/pre-push.py
Normal file
49
themes/hugo-theme-relearn/.githooks/pre-push.py
Normal file
@@ -0,0 +1,49 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
# This script avoids to push branches starting with a "#". This is the way
|
||||
# how I store ticket related feature branches that are work in progress.
|
||||
|
||||
# Once a feature branch is finished, it will be rebased to mains HEAD,
|
||||
# its commits squashed, merged into main and the branch deleted afterwards.
|
||||
|
||||
# Call this script from your ".git/hooks/pre-push" file like this (supporting
|
||||
# Linux, Windows and MacOS)
|
||||
|
||||
# #!/bin/sh
|
||||
# python3 .githooks/pre-push.py
|
||||
|
||||
from datetime import datetime
|
||||
import os
|
||||
import re
|
||||
import subprocess
|
||||
|
||||
# This hook is called with the following parameters:
|
||||
# $1 -- Name of the remote to which the push is being done
|
||||
# $2 -- URL to which the push is being done
|
||||
# If pushing without using a named remote, those arguments will be equal.
|
||||
|
||||
# Information about the commits being pushed is supplied as lines to
|
||||
# the standard input in the form:
|
||||
# <local ref> <local sha1> <remote ref> <remote sha1>
|
||||
# This hook prevents the push of commits that belong to branches starting with
|
||||
# an "#" (which are work in progress).
|
||||
|
||||
def main():
|
||||
script_name = "PRE-PUSH"
|
||||
script_dir = os.path.dirname(os.path.abspath(__file__))
|
||||
log_file = os.path.join(script_dir, "hooks.log")
|
||||
time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
|
||||
repo_root = subprocess.check_output(['git', 'rev-parse', '--show-toplevel'], universal_newlines=True).strip()
|
||||
repo_name = os.path.basename(repo_root)
|
||||
|
||||
local_branch = subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD'], universal_newlines=True).strip()
|
||||
wip_prefix = '^#\\d+(?:\\b.*)$'
|
||||
if re.match(wip_prefix, local_branch):
|
||||
print(f'{time}: {repo_name} - {script_name} - Branch "{local_branch}" was not pushed because its name starts with a "#" which marks it as work in progress', file=open(log_file, "a"))
|
||||
print(f'{script_name} - Branch "{local_branch}" was not pushed because its name starts with a "#" which marks it as work in progress')
|
||||
exit(1)
|
||||
print(f'{time}: {repo_name} - {script_name} - Branch "{local_branch}" was pushed', file=open(log_file, "a"))
|
||||
exit(0)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
1
themes/hugo-theme-relearn/.github/FUNDING.yml
vendored
Normal file
1
themes/hugo-theme-relearn/.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1 @@
|
||||
github: [McShelby]
|
||||
19
themes/hugo-theme-relearn/.github/actions/build_site/action.yaml
vendored
Normal file
19
themes/hugo-theme-relearn/.github/actions/build_site/action.yaml
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
name: Build site
|
||||
description: Builds the docs for later deploy on GitHub-Pages
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v3
|
||||
with:
|
||||
hugo-version: 'latest'
|
||||
|
||||
- name: Build docs
|
||||
shell: bash
|
||||
run: |
|
||||
hugo --source ${GITHUB_WORKSPACE}/docs --destination ${GITHUB_WORKSPACE}/../public --cleanDestinationDir --environment github --theme ${GITHUB_WORKSPACE}
|
||||
|
||||
- name: Build exampleSite
|
||||
shell: bash
|
||||
run: |
|
||||
hugo --source ${GITHUB_WORKSPACE}/exampleSite --destination ${GITHUB_WORKSPACE}/../public/exampleSite --environment github --theme ${GITHUB_WORKSPACE}
|
||||
110
themes/hugo-theme-relearn/.github/actions/check_milestone/action.yaml
vendored
Normal file
110
themes/hugo-theme-relearn/.github/actions/check_milestone/action.yaml
vendored
Normal file
@@ -0,0 +1,110 @@
|
||||
name: Check milestone
|
||||
description: Checks if the given milestone and its according tag are valid to be released
|
||||
inputs:
|
||||
milestone:
|
||||
description: Milestone for this release
|
||||
required: true
|
||||
github_token:
|
||||
description: Secret GitHub token
|
||||
required: true
|
||||
outputs:
|
||||
outcome:
|
||||
description: Result of the check, success or failure
|
||||
value: ${{ steps.outcome.outputs.outcome }}
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Get closed issues for milestone
|
||||
id: closed_issues
|
||||
uses: octokit/graphql-action@v2.x
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
with:
|
||||
query: |
|
||||
query {
|
||||
search(first: 1, type: ISSUE, query: "repo:${{ github.repository_owner }}/${{ github.event.repository.name }} milestone:${{ env.MILESTONE }} state:closed") {
|
||||
issueCount
|
||||
}
|
||||
}
|
||||
|
||||
- name: Get open issues for milestone
|
||||
id: open_issues
|
||||
uses: octokit/graphql-action@v2.x
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
with:
|
||||
query: |
|
||||
query {
|
||||
search(first: 1, type: ISSUE, query: "repo:${{ github.repository_owner }}/${{ github.event.repository.name }} milestone:${{ env.MILESTONE }} state:open") {
|
||||
issueCount
|
||||
}
|
||||
}
|
||||
|
||||
- name: Get current major version number
|
||||
id: majorvers
|
||||
uses: azarc-io/regex-property-action@master
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
value: ${{ env.MILESTONE }}
|
||||
regex: (\d+)\.\d+\.\d+
|
||||
replacement: "$1"
|
||||
|
||||
- name: Get current minor version number
|
||||
id: minorvers
|
||||
uses: azarc-io/regex-property-action@master
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
value: ${{ env.MILESTONE }}
|
||||
regex: \d+\.(\d+)\.\d+
|
||||
replacement: "$1"
|
||||
|
||||
- name: Get current patch version number
|
||||
id: patchvers
|
||||
uses: azarc-io/regex-property-action@master
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
value: ${{ env.MILESTONE }}
|
||||
regex: \d+\.\d+\.(\d+)
|
||||
replacement: "$1"
|
||||
|
||||
- name: Check if releasenotes exists
|
||||
id: releasenotes
|
||||
shell: bash
|
||||
run: |
|
||||
if [ -f "docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md" ]; then
|
||||
echo "file_exists=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "file_exists=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Set outcome
|
||||
id: outcome
|
||||
shell: bash
|
||||
run: |
|
||||
if [[ \
|
||||
${{ fromJSON(steps.closed_issues.outputs.data).search.issueCount }} -gt 0 && \
|
||||
${{ fromJSON(steps.open_issues.outputs.data).search.issueCount }} -eq 0 && \
|
||||
${{ steps.releasenotes.outputs.file_exists == 'true' }} \
|
||||
]]; then
|
||||
echo "outcome=success" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "outcome=failure" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Log results and exit
|
||||
shell: bash
|
||||
run: |
|
||||
echo outcome : ${{ steps.outcome.outputs.outcome }}
|
||||
echo has closed issues : ${{ fromJSON(steps.closed_issues.outputs.data).search.issueCount > 0 }}
|
||||
echo count : ${{ fromJSON(steps.closed_issues.outputs.data).search.issueCount }}
|
||||
echo has all issues closed : ${{ fromJSON(steps.open_issues.outputs.data).search.issueCount == 0 }}
|
||||
echo count : ${{ fromJSON(steps.open_issues.outputs.data).search.issueCount }}
|
||||
echo has releasenotes : ${{ steps.releasenotes.outputs.file_exists }}
|
||||
if [ "${{ steps.outcome.outputs.outcome }}" = "failure" ]; then
|
||||
exit 1
|
||||
fi
|
||||
17
themes/hugo-theme-relearn/.github/actions/deploy_site/action.yaml
vendored
Normal file
17
themes/hugo-theme-relearn/.github/actions/deploy_site/action.yaml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
name: Deploy site
|
||||
description: Deploys a built site on GitHub-Pages
|
||||
inputs:
|
||||
github_token:
|
||||
description: Secret GitHub token
|
||||
required: true
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Deploy site
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
GITHUB_WORKSPACE: ${{ github.workspace }}
|
||||
with:
|
||||
github_token: ${{ env.GITHUB_TOKEN }}
|
||||
publish_dir: ${{ env.GITHUB_WORKSPACE }}/../public
|
||||
222
themes/hugo-theme-relearn/.github/actions/release_milestone/action.yaml
vendored
Normal file
222
themes/hugo-theme-relearn/.github/actions/release_milestone/action.yaml
vendored
Normal file
@@ -0,0 +1,222 @@
|
||||
name: Release milestone
|
||||
description: Creates a release and tag out of a given milestone
|
||||
inputs:
|
||||
milestone:
|
||||
description: Milestone for this release
|
||||
required: true
|
||||
github_token:
|
||||
description: Secret GitHub token
|
||||
required: true
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '16'
|
||||
|
||||
- name: Setup git
|
||||
shell: bash
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
run: |
|
||||
git config user.name "GitHub Actions Bot"
|
||||
git config user.email "<>"
|
||||
|
||||
- name: Get current date
|
||||
id: date
|
||||
uses: Kaven-Universe/github-action-current-date-time@v1
|
||||
with:
|
||||
format: 'YYYY-MM-DD'
|
||||
|
||||
- name: Get current major version number
|
||||
id: majorvers
|
||||
uses: azarc-io/regex-property-action@master
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
value: ${{ env.MILESTONE }}
|
||||
regex: (\d+)\.\d+\.\d+
|
||||
replacement: "$1"
|
||||
|
||||
- name: Get current minor version number
|
||||
id: minorvers
|
||||
uses: azarc-io/regex-property-action@master
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
value: ${{ env.MILESTONE }}
|
||||
regex: \d+\.(\d+)\.\d+
|
||||
replacement: "$1"
|
||||
|
||||
- name: Get current patch version number
|
||||
id: patchvers
|
||||
uses: azarc-io/regex-property-action@master
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
value: ${{ env.MILESTONE }}
|
||||
regex: \d+\.\d+\.(\d+)
|
||||
replacement: "$1"
|
||||
|
||||
- name: Get current padded patch version number
|
||||
id: paddedpatchvers
|
||||
shell: bash
|
||||
run: |
|
||||
NUM=$(printf "%03d" ${{ steps.patchvers.outputs.value }})
|
||||
echo "value=$NUM" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Get next version number
|
||||
id: nextvers
|
||||
uses: WyriHaximus/github-action-next-semvers@v1
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
with:
|
||||
version: ${{ env.MILESTONE }}
|
||||
|
||||
- name: Close milestone
|
||||
uses: Akkjon/close-milestone@v2.1.0
|
||||
continue-on-error: true
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
with:
|
||||
milestone_name: ${{ env.MILESTONE }}
|
||||
|
||||
- name: Create temporary tag
|
||||
shell: bash
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
run: |
|
||||
git tag --message "" "$MILESTONE" || true
|
||||
git push origin "$MILESTONE" || true
|
||||
git tag --force --message "" "$MILESTONE"
|
||||
git push --force origin "$MILESTONE"
|
||||
|
||||
- name: Update generator version
|
||||
shell: bash
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
run: |
|
||||
echo -n "$MILESTONE" > layouts/partials/version.txt
|
||||
|
||||
- name: Generate english releasenotes
|
||||
shell: bash
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
GREN_GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
run: |
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/_index.en.md
|
||||
|
||||
- name: Update releasenotes front matter
|
||||
uses: surahmansada/file-regex-replace@v1
|
||||
with:
|
||||
regex: '(\ntitle = "Version )\d+\.\d+("\n.*\nweight = -)\d+(\n)'
|
||||
replacement: "$1${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}$2${{ steps.minorvers.outputs.value }}$3"
|
||||
include: docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
|
||||
|
||||
- name: Update releasenotes heading
|
||||
uses: surahmansada/file-regex-replace@v1
|
||||
with:
|
||||
regex: '(.)[\n\r\s]*[\n\r]+##\s+.*?[\n\r][\n\r\s]*(.)'
|
||||
replacement: "$1\n\n## ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}.0 (${{ steps.date.outputs.time }}) {#${{ steps.majorvers.outputs.value }}-${{ steps.minorvers.outputs.value }}-0}\n\n$2"
|
||||
include: docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.en.md
|
||||
|
||||
- name: Generate piratish releasenotes
|
||||
shell: bash
|
||||
run: |
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/_index.pir.md
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"releasenotes\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}.pir.md
|
||||
|
||||
- name: Generate english changelogs
|
||||
shell: bash
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
GREN_GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
run: |
|
||||
mkdir -p docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" %}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/_index.en.md
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n\n{{% pages showhidden=\"true\" showdivider=\"true\" reverse=\"true\" %}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.en.md
|
||||
npx github-release-notes@0.17.1 changelog --generate --changelog-filename docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md --tags "$MILESTONE"
|
||||
|
||||
- name: Generate piratish changelogs
|
||||
shell: bash
|
||||
run: |
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.majorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/_index.pir.md
|
||||
echo -e "+++\ndisableToc = false\nhidden = true\ntitle = \"Version ${{ steps.majorvers.outputs.value }}.${{ steps.minorvers.outputs.value }}\"\ntype = \"changelog\"\nweight = -${{ steps.minorvers.outputs.value }}\n+++\n{{< piratify >}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/_index.pir.md
|
||||
echo -e "+++\n+++\n{{< piratify >}}" > docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.pir.md
|
||||
|
||||
- name: Read changelog
|
||||
id: changelog_docs
|
||||
uses: guibranco/github-file-reader-action-v2@latest
|
||||
with:
|
||||
path: docs/content/introduction/changelog/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/${{ steps.paddedpatchvers.outputs.value }}.en.md
|
||||
|
||||
- name: Write changelog to CHANGELOG.md
|
||||
uses: surahmansada/file-regex-replace@v1
|
||||
with:
|
||||
regex: '(##\s+.*?[\n\r])[\n\r\s]*([\s\S]*)'
|
||||
replacement: "${{ steps.changelog_docs.outputs.contents }}\n---\n\n$1\n$2"
|
||||
include: CHANGELOG.md
|
||||
|
||||
- name: Set changelog for GitHub release
|
||||
id: changelog_github
|
||||
uses: azarc-io/regex-property-action@master
|
||||
with:
|
||||
value: ${{ steps.changelog_docs.outputs.contents }}
|
||||
regex: '(##\s+.*?[\n\r])[\n\r\s]*([\s\S]*)'
|
||||
replacement: "[★ What's new in this version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/${{ steps.majorvers.outputs.value }}/${{ steps.minorvers.outputs.value }}/)\n\n$2"
|
||||
|
||||
- name: Commit updates
|
||||
shell: bash
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
run: |
|
||||
git add *
|
||||
git commit --message "Ship tag $MILESTONE"
|
||||
git push origin main
|
||||
|
||||
- name: Create final tags
|
||||
shell: bash
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
MILESTONE_MAJOR: ${{ steps.majorvers.outputs.value }}
|
||||
MILESTONE_MINOR: ${{ steps.minorvers.outputs.value }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
run: |
|
||||
git tag --force --message "" "$MILESTONE"
|
||||
git push --force origin "$MILESTONE"
|
||||
git tag --message "" "$MILESTONE_MAJOR.$MILESTONE_MINOR.x" || true
|
||||
git push origin "$MILESTONE_MAJOR.$MILESTONE_MINOR.x" || true
|
||||
git tag --force --message "" "$MILESTONE_MAJOR.$MILESTONE_MINOR.x"
|
||||
git push --force origin "$MILESTONE_MAJOR.$MILESTONE_MINOR.x"
|
||||
git tag --message "" "$MILESTONE_MAJOR.x" || true
|
||||
git push origin "$MILESTONE_MAJOR.x" || true
|
||||
git tag --force --message "" "$MILESTONE_MAJOR.x"
|
||||
git push --force origin "$MILESTONE_MAJOR.x"
|
||||
git tag --message "" "x" || true
|
||||
git push origin "x" || true
|
||||
git tag --force --message "" "x"
|
||||
git push --force origin "x"
|
||||
|
||||
- name: Publish release
|
||||
uses: ncipollo/release-action@v1
|
||||
env:
|
||||
MILESTONE: ${{ inputs.milestone }}
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
with:
|
||||
body: |
|
||||
${{ steps.changelog_github.outputs.value }}
|
||||
tag: ${{ env.MILESTONE }}
|
||||
|
||||
- name: Create next patch milestone
|
||||
uses: WyriHaximus/github-action-create-milestone@v1
|
||||
continue-on-error: true
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ inputs.github_token }}
|
||||
with:
|
||||
title: ${{ steps.nextvers.outputs.patch }}
|
||||
25
themes/hugo-theme-relearn/.github/workflows/docs-build-deployment.yaml
vendored
Normal file
25
themes/hugo-theme-relearn/.github/workflows/docs-build-deployment.yaml
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
name: docs-build-deployment
|
||||
|
||||
on:
|
||||
push: # Build on all pushes but only deploy for main branch
|
||||
workflow_dispatch: # Allow this task to be manually started (you'll never know)
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
name: Run deploy
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name != 'push' || (github.event_name == 'push' && github.ref == 'refs/heads/main')
|
||||
steps:
|
||||
- name: Checkout repo
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
# fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - not necessary for this repo
|
||||
|
||||
- name: Build site
|
||||
uses: ./.github/actions/build_site
|
||||
|
||||
- name: Deploy site
|
||||
uses: ./.github/actions/deploy_site
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
21
themes/hugo-theme-relearn/.github/workflows/docs-build.yaml
vendored
Normal file
21
themes/hugo-theme-relearn/.github/workflows/docs-build.yaml
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
name: docs-build
|
||||
|
||||
on:
|
||||
push: # Build on all pushes but only deploy for main branch
|
||||
pull_request: # Build on all PRs regardless what branch
|
||||
workflow_dispatch: # Allow this task to be manually started (you'll never know)
|
||||
|
||||
jobs:
|
||||
ci:
|
||||
name: Run build
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name != 'push' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
|
||||
steps:
|
||||
- name: Checkout repo
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
# fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - not necessary for this repo
|
||||
|
||||
- name: Build site
|
||||
uses: ./.github/actions/build_site
|
||||
42
themes/hugo-theme-relearn/.github/workflows/version-release.yaml
vendored
Normal file
42
themes/hugo-theme-relearn/.github/workflows/version-release.yaml
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
name: version-release
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
milestone:
|
||||
description: 'Milestone for this release'
|
||||
required: true
|
||||
|
||||
jobs:
|
||||
release:
|
||||
name: Run release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repo
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
# fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - not necessary for this repo
|
||||
|
||||
- name: Check milestone
|
||||
id: check
|
||||
uses: ./.github/actions/check_milestone
|
||||
with:
|
||||
milestone: ${{ github.event.inputs.milestone }}
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Create release
|
||||
if: ${{ steps.check.outputs.outcome == 'success' }}
|
||||
uses: ./.github/actions/release_milestone
|
||||
with:
|
||||
milestone: ${{ github.event.inputs.milestone }}
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
# We need to deploy the site again to show the updated changelog
|
||||
- name: Build site
|
||||
uses: ./.github/actions/build_site
|
||||
|
||||
- name: Deploy site
|
||||
uses: ./.github/actions/deploy_site
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
8
themes/hugo-theme-relearn/.gitignore
vendored
Normal file
8
themes/hugo-theme-relearn/.gitignore
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
.DS_Store
|
||||
.githooks/hooks.log
|
||||
.hugo_build.lock
|
||||
docs/public*
|
||||
exampleSite/public*
|
||||
hugo*.exe
|
||||
*.xcf
|
||||
*.zip
|
||||
20
themes/hugo-theme-relearn/.grenrc.js
Normal file
20
themes/hugo-theme-relearn/.grenrc.js
Normal file
@@ -0,0 +1,20 @@
|
||||
module.exports = {
|
||||
changelogFilename: 'CHANGELOG.md',
|
||||
dataSource: 'milestones',
|
||||
groupBy: {
|
||||
Enhancements: ['feature'],
|
||||
Fixes: ['bug'],
|
||||
Maintenance: ['task'],
|
||||
Uncategorised: ['closed'],
|
||||
},
|
||||
ignoreLabels: ['asciidoc', 'blocked', 'browser', 'device', 'helpwanted', 'hugo', 'idea', 'mermaid', 'needsfeedback', 'undecided'],
|
||||
ignoreIssuesWith: ['discussion', 'documentation', 'duplicate', 'invalid', 'support', 'unresolved', 'update', 'wontchange'],
|
||||
ignoreTagsWith: ['Relearn', 'x'],
|
||||
milestoneMatch: '{{tag_name}}',
|
||||
onlyMilestones: true,
|
||||
template: {
|
||||
changelogTitle: '',
|
||||
group: '\n### {{heading}}\n',
|
||||
release: ({ body, date, release }) => `## ${release} (` + date.replace(/(\d+)\/(\d+)\/(\d+)/, '$3-$2-$1') + `)\n${body}`,
|
||||
},
|
||||
};
|
||||
5
themes/hugo-theme-relearn/.imgbotconfig
Normal file
5
themes/hugo-theme-relearn/.imgbotconfig
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"schedule": "daily",
|
||||
"ignoredFiles": ["static/*"],
|
||||
"prTitle": "autobot: optimize images"
|
||||
}
|
||||
7
themes/hugo-theme-relearn/.issuetracker
Normal file
7
themes/hugo-theme-relearn/.issuetracker
Normal file
@@ -0,0 +1,7 @@
|
||||
# Integration with Issue Tracker
|
||||
#
|
||||
# (note that '\' need to be escaped).
|
||||
|
||||
[issuetracker "GitHub Rule"]
|
||||
regex = "#(\\d+)"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn/issues/$1"
|
||||
22
themes/hugo-theme-relearn/.prettierignore
Normal file
22
themes/hugo-theme-relearn/.prettierignore
Normal file
@@ -0,0 +1,22 @@
|
||||
assets/css/chroma*.css
|
||||
assets/css/variables.css
|
||||
assets/_relearn_searchindex.js
|
||||
docs/.frontmatter
|
||||
docs/content
|
||||
docs/layouts
|
||||
docs/static
|
||||
docs/frontmatter.json
|
||||
exampleSite
|
||||
layouts
|
||||
static/css/auto-complete.css
|
||||
static/css/*.min.css
|
||||
static/css/swagger*.css
|
||||
static/js/d3
|
||||
static/js/lunr
|
||||
static/js/mathjax
|
||||
static/js/swagger-ui
|
||||
static/js/auto-complete.js
|
||||
static/js/*.min.js
|
||||
*.md
|
||||
*.yaml
|
||||
*.yml
|
||||
8
themes/hugo-theme-relearn/.prettierrc.json
Normal file
8
themes/hugo-theme-relearn/.prettierrc.json
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"endOfLine": "auto",
|
||||
"quoteProps": "consistent",
|
||||
"trailingComma": "es5",
|
||||
"semi": true,
|
||||
"singleAttributePerLine": true,
|
||||
"singleQuote": true
|
||||
}
|
||||
3
themes/hugo-theme-relearn/.vscode/extensions.json
vendored
Normal file
3
themes/hugo-theme-relearn/.vscode/extensions.json
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"recommendations": ["esbenp.prettier-vscode"]
|
||||
}
|
||||
20
themes/hugo-theme-relearn/.vscode/settings.json
vendored
Normal file
20
themes/hugo-theme-relearn/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"[css]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[javascript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[json]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[yaml]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"editor.formatOnSave": true,
|
||||
"extensions.ignoreRecommendations": false,
|
||||
"prettier.useEditorConfig": true,
|
||||
"spellright.documentTypes": ["latex", "markdown"],
|
||||
"spellright.language": ["en"]
|
||||
}
|
||||
1986
themes/hugo-theme-relearn/CHANGELOG.md
Normal file
1986
themes/hugo-theme-relearn/CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
23
themes/hugo-theme-relearn/LICENSE
Normal file
23
themes/hugo-theme-relearn/LICENSE
Normal file
@@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2021 Sören Weber
|
||||
Copyright (c) 2017 Valere JEANTET
|
||||
Copyright (c) 2016 MATHIEU CORNIC
|
||||
Copyright (c) 2014 Grav
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
84
themes/hugo-theme-relearn/README.md
Normal file
84
themes/hugo-theme-relearn/README.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# Hugo Relearn Theme
|
||||
|
||||
A theme for [Hugo](https://gohugo.io/) designed for documentation.
|
||||
|
||||
[★ What's new in the latest version ★](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes)
|
||||
|
||||

|
||||
|
||||
## Overview
|
||||
|
||||
The Relearn theme is an enhanced fork of the popular [Learn theme](https://github.com/matcornic/hugo-theme-learn). It aims to address long-standing issues and incorporate the latest Hugo features while trying to maintain compatibility with its predecessor.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Versatile Usage**
|
||||
- [Responsive design for mobile devices](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/width)
|
||||
- [Looks nice on paper](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/outputformats) - if it has to
|
||||
- [Usable offline with no external dependencies](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/deployment#offline-usage)
|
||||
- [Usable from your local file system without a web server](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/deployment#file-system) via `file://` protocol
|
||||
- [Integration with the VSCode Front Matter CMS extension](https://mcshelby.github.io/hugo-theme-relearn/introduction/tools#front-matter-cms) for on-premise CMS capabilities
|
||||
|
||||
- **Customizable Appearance**
|
||||
- [Flexible brand image configuration](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/logo#change-the-logo)
|
||||
- [Automatic light/dark mode switching based on OS settings](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#adjust-to-os-settings)
|
||||
- [Many pre-defined color variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#shipped-variants)
|
||||
- [User-selectable variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#multiple-variants)
|
||||
- [Built-in stylesheet generator](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/generator)
|
||||
- [Customizable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/modules/#change-syntax-highlighting)
|
||||
|
||||
- **Advanced Functionality**
|
||||
- [Chapter and site-wide printing capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/outputformats#print-support)
|
||||
- [Versatile search options: in-page, popup, and dedicated search page](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search)
|
||||
- [Customizable top bar buttons](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/topbar)
|
||||
- [Configurable menus](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/menus)
|
||||
- [Support for hidden pages](https://mcshelby.github.io/hugo-theme-relearn/configuration/content/hidden)
|
||||
- [Comprehensive taxonomy support](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/taxonomy)
|
||||
- [Social media integration](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/meta#social-media-images)
|
||||
|
||||
- **Multilingual Support**
|
||||
- [Full right-to-left (RTL) language support](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/multilingual)
|
||||
- [Extensive list of supported languages](https://mcshelby.github.io/hugo-theme-relearn/configuration/sitemanagement/multilingual): Arabic, Chinese (Simplified and Traditional), Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Swahili, Turkish, Vietnamese
|
||||
- [Multilingual content search capabilities](https://mcshelby.github.io/hugo-theme-relearn/configuration/sidebar/search#mixed-language-support)
|
||||
|
||||
- **Enhanced Markdown Features**
|
||||
- [CommonMark compliant](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown)
|
||||
- [Support for Markdown extensions like GitHub Flavored Markdown](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown#standard-and-extensions)
|
||||
- [Support for Obsidian callouts](https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown#obsidian-callouts)
|
||||
- [Advanced link manipulation like download and target](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/linkeffects)
|
||||
- [Advanced image manipulation like lightbox, sizing, shadows, borders and alignment](https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/imageeffects)
|
||||
|
||||
- **Rich Shortcode Library**
|
||||
- [Marker badges](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/badge)
|
||||
- [Flexible buttons](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/button)
|
||||
- [Child page listing](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/children)
|
||||
- [Expandable content areas](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/expand)
|
||||
- [Font Awesome icon integration](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon)
|
||||
- [File inclusion capabilities](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/include)
|
||||
- [Math support for mathematical and chemical formulae](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/math)
|
||||
- [Mermaid diagram integration](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid)
|
||||
- [Styled notice boxes](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/notice)
|
||||
- [OpenAPI specification rendering](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi)
|
||||
- [Page bundle resource display](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/resources)
|
||||
- [Site configuration parameter display](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/siteparam)
|
||||
- [Tab-based content organization](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tab) and [multi-tab panels](https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tabs)
|
||||
|
||||
## Getting Started
|
||||
|
||||
For a comprehensive guide on the theme's capabilities, please refer to the [official documentation](https://mcshelby.github.io/hugo-theme-relearn/introduction/quickstart).
|
||||
|
||||
## Updates and Changes
|
||||
|
||||
Visit the [What's New](https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes) page for feature highlights or the [detailed changelog](https://mcshelby.github.io/hugo-theme-relearn/introduction/changelog) for a complete list of updates.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions for bug fixes and new features. Please see the [contribution guidelines](https://mcshelby.github.io/hugo-theme-relearn/development/contributing) before getting started.
|
||||
|
||||
## Licensing
|
||||
|
||||
The Relearn theme is distributed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).
|
||||
|
||||
## Credits
|
||||
|
||||
This theme builds upon the work of [many contributors](https://mcshelby.github.io/hugo-theme-relearn/more/credits).
|
||||
7
themes/hugo-theme-relearn/archetypes/chapter.md
Normal file
7
themes/hugo-theme-relearn/archetypes/chapter.md
Normal file
@@ -0,0 +1,7 @@
|
||||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
type = "chapter"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
This is a new chapter.
|
||||
5
themes/hugo-theme-relearn/archetypes/default.md
Normal file
5
themes/hugo-theme-relearn/archetypes/default.md
Normal file
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
+++
|
||||
|
||||
This is a new page.
|
||||
6
themes/hugo-theme-relearn/archetypes/home.md
Normal file
6
themes/hugo-theme-relearn/archetypes/home.md
Normal file
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
type = "home"
|
||||
+++
|
||||
|
||||
This is your new home page.
|
||||
19
themes/hugo-theme-relearn/assets/_relearn_searchindex.js
Normal file
19
themes/hugo-theme-relearn/assets/_relearn_searchindex.js
Normal file
@@ -0,0 +1,19 @@
|
||||
{{- $pages := slice }}
|
||||
{{- range .Site.Pages }}
|
||||
{{- if partial "_relearn/pageIsSpecial.gotmpl" . }}
|
||||
{{- else if and .Title .RelPermalink (or (ne .Site.Params.disableSearchHiddenPages true) (not (partialCached "_relearn/pageIsHiddenSelfOrAncestor.gotmpl" (dict "page" . "to" .Site.Home) .Path .Site.Home.Path) ) ) }}
|
||||
{{- $tags := slice }}
|
||||
{{- range .GetTerms "tags" }}
|
||||
{{- $tags = $tags | append (partial "title.gotmpl" (dict "page" .Page "linkTitle" true) | plainify) }}
|
||||
{{- end }}
|
||||
{{- $pages = $pages | append (dict
|
||||
"uri" (partial "permalink.gotmpl" (dict "to" .))
|
||||
"title" (partial "title.gotmpl" (dict "page" .) | plainify)
|
||||
"tags" $tags
|
||||
"breadcrumb" (trim (partial "breadcrumbs.html" (dict "page" . "dirOnly" true) | plainify | htmlUnescape) "\n\r\t ")
|
||||
"description" (trim (or .Description .Summary | plainify | htmlUnescape) "\n\r\t " )
|
||||
"content" (trim (.Plain | htmlUnescape) "\n\r\t ")
|
||||
) }}
|
||||
{{- end }}
|
||||
{{- end -}}
|
||||
var relearn_searchindex = {{ $pages | jsonify (dict "indent" " ") }}
|
||||
87
themes/hugo-theme-relearn/assets/css/chroma-learn.css
Normal file
87
themes/hugo-theme-relearn/assets/css/chroma-learn.css
Normal file
@@ -0,0 +1,87 @@
|
||||
/* based on base16-snazzy */
|
||||
/* Background */ .bg { color: #e2e4e5; background-color: #282a36; }
|
||||
/* PreWrapper */ .chroma { color: #e2e4e5; background-color: #282a36; }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { color: #ff5c57 }
|
||||
/* CodeLine */ .chroma .cl { }
|
||||
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
||||
/* LineHighlight */ .chroma .hl { background-color: #505050 }
|
||||
/* LineNumbersTable */ .chroma .lnt { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* LineNumbers */ .chroma .ln { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* Line */ .chroma .line { display: flex; }
|
||||
/* Keyword */ .chroma .k { color: #ff6ac1 }
|
||||
/* KeywordConstant */ .chroma .kc { color: #ff6ac1 }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #ff5c57 }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #ff6ac1 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #ff6ac1 }
|
||||
/* KeywordReserved */ .chroma .kr { color: #ff6ac1 }
|
||||
/* KeywordType */ .chroma .kt { color: #9aedfe }
|
||||
/* Name */ .chroma .n { }
|
||||
/* NameAttribute */ .chroma .na { color: #57c7ff }
|
||||
/* NameBuiltin */ .chroma .nb { color: #ff5c57 }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||
/* NameClass */ .chroma .nc { color: #f3f99d }
|
||||
/* NameConstant */ .chroma .no { color: #ff9f43 }
|
||||
/* NameDecorator */ .chroma .nd { color: #ff9f43 }
|
||||
/* NameEntity */ .chroma .ni { }
|
||||
/* NameException */ .chroma .ne { }
|
||||
/* NameFunction */ .chroma .nf { color: #57c7ff }
|
||||
/* NameFunctionMagic */ .chroma .fm { }
|
||||
/* NameLabel */ .chroma .nl { color: #ff5c57 }
|
||||
/* NameNamespace */ .chroma .nn { }
|
||||
/* NameOther */ .chroma .nx { }
|
||||
/* NameProperty */ .chroma .py { }
|
||||
/* NameTag */ .chroma .nt { color: #ff6ac1 }
|
||||
/* NameVariable */ .chroma .nv { color: #ff5c57 }
|
||||
/* NameVariableClass */ .chroma .vc { color: #ff5c57 }
|
||||
/* NameVariableGlobal */ .chroma .vg { color: #ff5c57 }
|
||||
/* NameVariableInstance */ .chroma .vi { color: #ff5c57 }
|
||||
/* NameVariableMagic */ .chroma .vm { }
|
||||
/* Literal */ .chroma .l { }
|
||||
/* LiteralDate */ .chroma .ld { }
|
||||
/* LiteralString */ .chroma .s { color: #5af78e }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #5af78e }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #5af78e }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #5af78e }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #5af78e }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #5af78e }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #5af78e }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #5af78e }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #5af78e }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #5af78e }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #5af78e }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #5af78e }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #5af78e }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #5af78e }
|
||||
/* LiteralNumber */ .chroma .m { color: #ff9f43 }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ff9f43 }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ff9f43 }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ff9f43 }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ff9f43 }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ff9f43 }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ff9f43 }
|
||||
/* Operator */ .chroma .o { color: #ff6ac1 }
|
||||
/* OperatorWord */ .chroma .ow { color: #ff6ac1 }
|
||||
/* Punctuation */ .chroma .p { }
|
||||
/* Comment */ .chroma .c { color: #78787e }
|
||||
/* CommentHashbang */ .chroma .ch { color: #78787e }
|
||||
/* CommentMultiline */ .chroma .cm { color: #78787e }
|
||||
/* CommentSingle */ .chroma .c1 { color: #78787e }
|
||||
/* CommentSpecial */ .chroma .cs { color: #78787e }
|
||||
/* CommentPreproc */ .chroma .cp { color: #78787e }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #78787e }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { color: #ff5c57 }
|
||||
/* GenericEmph */ .chroma .ge { text-decoration: underline }
|
||||
/* GenericError */ .chroma .gr { color: #ff5c57 }
|
||||
/* GenericHeading */ .chroma .gh { font-weight: bold }
|
||||
/* GenericInserted */ .chroma .gi { font-weight: bold }
|
||||
/* GenericOutput */ .chroma .go { color: #43454f }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { font-style: italic }
|
||||
/* GenericSubheading */ .chroma .gu { font-weight: bold }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { text-decoration: underline }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
87
themes/hugo-theme-relearn/assets/css/chroma-neon.css
Normal file
87
themes/hugo-theme-relearn/assets/css/chroma-neon.css
Normal file
@@ -0,0 +1,87 @@
|
||||
/* based on rrt */
|
||||
/* Background */ .bg { color: #f8f8f2; background-color: #000000; }
|
||||
/* PreWrapper */ .chroma { color: #f8f8f2; background-color: #000000; }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { }
|
||||
/* CodeLine */ .chroma .cl { }
|
||||
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
||||
/* LineHighlight */ .chroma .hl { background-color: #363638 }
|
||||
/* LineNumbersTable */ .chroma .lnt { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7c7c79 }
|
||||
/* LineNumbers */ .chroma .ln { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7c7c79 }
|
||||
/* Line */ .chroma .line { display: flex; }
|
||||
/* Keyword */ .chroma .k { color: #ff0000 }
|
||||
/* KeywordConstant */ .chroma .kc { color: #ff0000 }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #ff0000 }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #ff0000 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #ff0000 }
|
||||
/* KeywordReserved */ .chroma .kr { color: #ff0000 }
|
||||
/* KeywordType */ .chroma .kt { color: #ee82ee }
|
||||
/* Name */ .chroma .n { }
|
||||
/* NameAttribute */ .chroma .na { }
|
||||
/* NameBuiltin */ .chroma .nb { }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||
/* NameClass */ .chroma .nc { }
|
||||
/* NameConstant */ .chroma .no { color: #7fffd4 }
|
||||
/* NameDecorator */ .chroma .nd { }
|
||||
/* NameEntity */ .chroma .ni { }
|
||||
/* NameException */ .chroma .ne { }
|
||||
/* NameFunction */ .chroma .nf { color: #ffff00 }
|
||||
/* NameFunctionMagic */ .chroma .fm { }
|
||||
/* NameLabel */ .chroma .nl { }
|
||||
/* NameNamespace */ .chroma .nn { }
|
||||
/* NameOther */ .chroma .nx { }
|
||||
/* NameProperty */ .chroma .py { }
|
||||
/* NameTag */ .chroma .nt { }
|
||||
/* NameVariable */ .chroma .nv { color: #eedd82 }
|
||||
/* NameVariableClass */ .chroma .vc { }
|
||||
/* NameVariableGlobal */ .chroma .vg { }
|
||||
/* NameVariableInstance */ .chroma .vi { }
|
||||
/* NameVariableMagic */ .chroma .vm { }
|
||||
/* Literal */ .chroma .l { }
|
||||
/* LiteralDate */ .chroma .ld { }
|
||||
/* LiteralString */ .chroma .s { color: #87ceeb }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #87ceeb }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #87ceeb }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #87ceeb }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #87ceeb }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #87ceeb }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #87ceeb }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #87ceeb }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #87ceeb }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #87ceeb }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #87ceeb }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #87ceeb }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #87ceeb }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #ff6600 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ff6600 }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ff6600 }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ff6600 }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ff6600 }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ff6600 }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ff6600 }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ff6600 }
|
||||
/* Operator */ .chroma .o { }
|
||||
/* OperatorWord */ .chroma .ow { }
|
||||
/* Punctuation */ .chroma .p { }
|
||||
/* Comment */ .chroma .c { color: #00ff00 }
|
||||
/* CommentHashbang */ .chroma .ch { color: #00ff00 }
|
||||
/* CommentMultiline */ .chroma .cm { color: #00ff00 }
|
||||
/* CommentSingle */ .chroma .c1 { color: #00ff00 }
|
||||
/* CommentSpecial */ .chroma .cs { color: #00ff00 }
|
||||
/* CommentPreproc */ .chroma .cp { color: #e5e5e5 }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #e5e5e5 }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { }
|
||||
/* GenericEmph */ .chroma .ge { }
|
||||
/* GenericError */ .chroma .gr { }
|
||||
/* GenericHeading */ .chroma .gh { }
|
||||
/* GenericInserted */ .chroma .gi { }
|
||||
/* GenericOutput */ .chroma .go { }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { }
|
||||
/* GenericSubheading */ .chroma .gu { }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
87
themes/hugo-theme-relearn/assets/css/chroma-relearn-dark.css
Normal file
87
themes/hugo-theme-relearn/assets/css/chroma-relearn-dark.css
Normal file
@@ -0,0 +1,87 @@
|
||||
/* based on monokai */
|
||||
/* Background */ .bg { color: #f8f8f2; background-color: #2b2b2b; }
|
||||
/* PreWrapper */ .chroma { color: #f8f8f2; background-color: #2b2b2b; }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { color: #cc66cc; }
|
||||
/* CodeLine */ .chroma .cl { }
|
||||
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
||||
/* LineHighlight */ .chroma .hl { background-color: #404042 }
|
||||
/* LineNumbersTable */ .chroma .lnt { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* LineNumbers */ .chroma .ln { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* Line */ .chroma .line { display: flex; }
|
||||
/* Keyword */ .chroma .k { color: #66d9ef }
|
||||
/* KeywordConstant */ .chroma .kc { color: #66d9ef }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #66d9ef }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #66d9ef }
|
||||
/* KeywordReserved */ .chroma .kr { color: #66d9ef }
|
||||
/* KeywordType */ .chroma .kt { color: #66d9ef }
|
||||
/* Name */ .chroma .n { }
|
||||
/* NameAttribute */ .chroma .na { color: #a6e22e }
|
||||
/* NameBuiltin */ .chroma .nb { }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||
/* NameClass */ .chroma .nc { color: #a6e22e }
|
||||
/* NameConstant */ .chroma .no { color: #66d9ef }
|
||||
/* NameDecorator */ .chroma .nd { color: #a6e22e }
|
||||
/* NameEntity */ .chroma .ni { }
|
||||
/* NameException */ .chroma .ne { color: #a6e22e }
|
||||
/* NameFunction */ .chroma .nf { color: #a6e22e }
|
||||
/* NameFunctionMagic */ .chroma .fm { }
|
||||
/* NameLabel */ .chroma .nl { }
|
||||
/* NameNamespace */ .chroma .nn { }
|
||||
/* NameOther */ .chroma .nx { color: #a6e22e }
|
||||
/* NameProperty */ .chroma .py { }
|
||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
||||
/* NameVariable */ .chroma .nv { }
|
||||
/* NameVariableClass */ .chroma .vc { }
|
||||
/* NameVariableGlobal */ .chroma .vg { }
|
||||
/* NameVariableInstance */ .chroma .vi { }
|
||||
/* NameVariableMagic */ .chroma .vm { }
|
||||
/* Literal */ .chroma .l { color: #ae81ff }
|
||||
/* LiteralDate */ .chroma .ld { color: #e6db74 }
|
||||
/* LiteralString */ .chroma .s { color: #e6db74 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #e6db74 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #e6db74 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #e6db74 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #e6db74 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #e6db74 }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #e6db74 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #ae81ff }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #e6db74 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #e6db74 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #e6db74 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #e6db74 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #e6db74 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #e6db74 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
||||
/* Operator */ .chroma .o { color: #f92672 }
|
||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
||||
/* Punctuation */ .chroma .p { }
|
||||
/* Comment */ .chroma .c { color: #75715e }
|
||||
/* CommentHashbang */ .chroma .ch { color: #75715e }
|
||||
/* CommentMultiline */ .chroma .cm { color: #75715e }
|
||||
/* CommentSingle */ .chroma .c1 { color: #75715e }
|
||||
/* CommentSpecial */ .chroma .cs { color: #75715e }
|
||||
/* CommentPreproc */ .chroma .cp { color: #75715e }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #75715e }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { color: #f92672 }
|
||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||
/* GenericError */ .chroma .gr { }
|
||||
/* GenericHeading */ .chroma .gh { }
|
||||
/* GenericInserted */ .chroma .gi { color: #a6e22e }
|
||||
/* GenericOutput */ .chroma .go { }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { color: #75715e }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
@@ -0,0 +1,87 @@
|
||||
/* based on monokailight */
|
||||
/* Background */ .bg { color: #272822; background-color: #fafafa; }
|
||||
/* PreWrapper */ .chroma { color: #272822; background-color: #fafafa; }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { color: #960050; }
|
||||
/* CodeLine */ .chroma .cl { }
|
||||
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
||||
/* LineHighlight */ .chroma .hl { background-color: #e1e1e1 }
|
||||
/* LineNumbersTable */ .chroma .lnt { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* LineNumbers */ .chroma .ln { white-space: pre; -webkit-user-select: none; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* Line */ .chroma .line { display: flex; }
|
||||
/* Keyword */ .chroma .k { color: #00a8c8 }
|
||||
/* KeywordConstant */ .chroma .kc { color: #00a8c8 }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #00a8c8 }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #00a8c8 }
|
||||
/* KeywordReserved */ .chroma .kr { color: #00a8c8 }
|
||||
/* KeywordType */ .chroma .kt { color: #00a8c8 }
|
||||
/* Name */ .chroma .n { color: #111111 }
|
||||
/* NameAttribute */ .chroma .na { color: #75af00 }
|
||||
/* NameBuiltin */ .chroma .nb { color: #111111 }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { color: #111111 }
|
||||
/* NameClass */ .chroma .nc { color: #75af00 }
|
||||
/* NameConstant */ .chroma .no { color: #00a8c8 }
|
||||
/* NameDecorator */ .chroma .nd { color: #75af00 }
|
||||
/* NameEntity */ .chroma .ni { color: #111111 }
|
||||
/* NameException */ .chroma .ne { color: #75af00 }
|
||||
/* NameFunction */ .chroma .nf { color: #75af00 }
|
||||
/* NameFunctionMagic */ .chroma .fm { color: #111111 }
|
||||
/* NameLabel */ .chroma .nl { color: #111111 }
|
||||
/* NameNamespace */ .chroma .nn { color: #111111 }
|
||||
/* NameOther */ .chroma .nx { color: #75af00 }
|
||||
/* NameProperty */ .chroma .py { color: #111111 }
|
||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
||||
/* NameVariable */ .chroma .nv { color: #111111 }
|
||||
/* NameVariableClass */ .chroma .vc { color: #111111 }
|
||||
/* NameVariableGlobal */ .chroma .vg { color: #111111 }
|
||||
/* NameVariableInstance */ .chroma .vi { color: #111111 }
|
||||
/* NameVariableMagic */ .chroma .vm { color: #111111 }
|
||||
/* Literal */ .chroma .l { color: #ae81ff }
|
||||
/* LiteralDate */ .chroma .ld { color: #d88200 }
|
||||
/* LiteralString */ .chroma .s { color: #d88200 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #d88200 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #d88200 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #d88200 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #d88200 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #d88200 }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #d88200 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #8045ff }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #d88200 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #d88200 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #d88200 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #d88200 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #d88200 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #d88200 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
||||
/* Operator */ .chroma .o { color: #f92672 }
|
||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
||||
/* Punctuation */ .chroma .p { color: #111111 }
|
||||
/* Comment */ .chroma .c { color: #a7a187 }
|
||||
/* CommentHashbang */ .chroma .ch { color: #a7a187 }
|
||||
/* CommentMultiline */ .chroma .cm { color: #a7a187 }
|
||||
/* CommentSingle */ .chroma .c1 { color: #a7a187 }
|
||||
/* CommentSpecial */ .chroma .cs { color: #a7a187 }
|
||||
/* CommentPreproc */ .chroma .cp { color: #a7a187 }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #a7a187 }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { }
|
||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||
/* GenericError */ .chroma .gr { }
|
||||
/* GenericHeading */ .chroma .gh { }
|
||||
/* GenericInserted */ .chroma .gi { }
|
||||
/* GenericOutput */ .chroma .go { }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
73
themes/hugo-theme-relearn/assets/css/fonts.css
Normal file
73
themes/hugo-theme-relearn/assets/css/fonts.css
Normal file
@@ -0,0 +1,73 @@
|
||||
/* Roboto Flex
|
||||
/* Variant 1: Every glyph, every axis, one big file */
|
||||
/* - Download TTF font from https://github.com/googlefonts/Roboto-flex */
|
||||
/* - Convert TTF to WOFF2 using any converter tool */
|
||||
/*
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url("../webfonts/RobotoFlex.woff2") format('woff2-variations');
|
||||
}
|
||||
*/
|
||||
|
||||
/* Variant 2: Splitted glyphs, selected axes, multiple moderatly sized files */
|
||||
/* - Download CSS with selected axes https://fonts.googleapis.com/css2?family=Roboto+Flex:opsz,wdth,wght,GRAD,YTFI@8..144,118,100..1000,-200..150,710&display=swap
|
||||
/* - Downlaod fonts of src attributes of resulting CSS and edit file names accordingly */
|
||||
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url('../webfonts/RobotoFlex.cyrillic-ext.woff2') format('woff2-variations');
|
||||
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url('../webfonts/RobotoFlex.cyrillic.woff2') format('woff2-variations');
|
||||
unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url('../webfonts/RobotoFlex.greek.woff2') format('woff2-variations');
|
||||
unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url('../webfonts/RobotoFlex.vietnamese.woff2') format('woff2-variations');
|
||||
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url('../webfonts/RobotoFlex.latin-ext.woff2') format('woff2-variations');
|
||||
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Roboto Flex';
|
||||
font-style: normal;
|
||||
font-weight: 100 1000;
|
||||
font-stretch: 100%;
|
||||
font-display: swap;
|
||||
src: url('../webfonts/RobotoFlex.latin.woff2') format('woff2-variations');
|
||||
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
|
||||
}
|
||||
211
themes/hugo-theme-relearn/assets/css/format-print.css
Normal file
211
themes/hugo-theme-relearn/assets/css/format-print.css
Normal file
@@ -0,0 +1,211 @@
|
||||
#R-sidebar {
|
||||
display: none;
|
||||
}
|
||||
#R-body {
|
||||
margin-left: 0 !important;
|
||||
margin-right: 0 !important;
|
||||
min-width: 100% !important;
|
||||
max-width: 100% !important;
|
||||
width: 100% !important;
|
||||
}
|
||||
#R-body #navigation {
|
||||
display: none;
|
||||
}
|
||||
html {
|
||||
font-size: 8.763pt;
|
||||
}
|
||||
body {
|
||||
background-color: rgba(255, 255, 255, 1);
|
||||
}
|
||||
code.copy-to-clipboard-code {
|
||||
border-start-end-radius: 2px;
|
||||
border-end-end-radius: 2px;
|
||||
border-inline-end-width: 1px;
|
||||
}
|
||||
pre:not(.mermaid) {
|
||||
border: 1px solid rgba(204, 204, 204, 1);
|
||||
}
|
||||
#R-body #R-topbar {
|
||||
background-color: rgba(255, 255, 255, 1); /* avoid background bleeding*/
|
||||
border-bottom: 1px solid rgba(221, 221, 221, 1);
|
||||
border-radius: 0;
|
||||
color: rgba(119, 119, 119, 1);
|
||||
padding-left: 0; /* for print, we want to align with the footer to ease the layout */
|
||||
padding-right: 0;
|
||||
}
|
||||
#R-body .topbar-button {
|
||||
/* we don't need the buttons while printing */
|
||||
/* we need !important to turn off JS topbar button handling setting element styles */
|
||||
display: none !important;
|
||||
}
|
||||
@media screen and (max-width: 47.999rem) {
|
||||
#R-body .topbar-breadcrumbs {
|
||||
visibility: visible;
|
||||
}
|
||||
}
|
||||
#R-body .copy-to-clipboard-code {
|
||||
padding-inline-end: 2px;
|
||||
}
|
||||
#R-body .inline-copy-to-clipboard-button,
|
||||
#R-body .block-copy-to-clipboard-button {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#R-body .inline-copy-to-clipboard-button + code.copy-to-clipboard-code,
|
||||
#R-body code.copy-to-clipboard-code:has(+ .inline-copy-to-clipboard-button) {
|
||||
border-end-end-radius: 2px;
|
||||
border-start-end-radius: 2px;
|
||||
border-inline-end-width: 1px;
|
||||
margin-inline-end: 0;
|
||||
}
|
||||
|
||||
#R-body .svg-reset-button {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#R-body h1,
|
||||
#R-body h2,
|
||||
#R-body h3,
|
||||
#R-body .article-subheading,
|
||||
#R-body h4,
|
||||
#R-body h5,
|
||||
#R-body h6 {
|
||||
/* better contrast for colored elements */
|
||||
color: rgba(0, 0, 0, 1);
|
||||
}
|
||||
#R-body th,
|
||||
#R-body td,
|
||||
#R-body code,
|
||||
#R-body strong,
|
||||
#R-body b,
|
||||
#R-body li,
|
||||
#R-body dd,
|
||||
#R-body dt,
|
||||
#R-body p,
|
||||
#R-body a,
|
||||
#R-body button,
|
||||
#R-body .badge .badge-content {
|
||||
/* better contrast for colored elements */
|
||||
color: rgba(0, 0, 0, 1);
|
||||
}
|
||||
#R-body .anchor {
|
||||
display: none;
|
||||
}
|
||||
#R-body pre:not(.mermaid),
|
||||
#R-body code {
|
||||
background-color: rgba(255, 255, 255, 1);
|
||||
border-color: rgba(221, 221, 221, 1);
|
||||
}
|
||||
|
||||
hr {
|
||||
border-bottom: 1px solid rgba(221, 221, 221, 1);
|
||||
}
|
||||
#R-body #R-body-inner {
|
||||
overflow: visible; /* turn off limitations for perfect scrollbar */
|
||||
/* reset paddings for chapters in screen */
|
||||
padding: 0 3.25rem 4rem 3.25rem;
|
||||
}
|
||||
|
||||
#R-body #R-body-inner h1 {
|
||||
border-bottom: 1px solid rgba(221, 221, 221, 1);
|
||||
font-size: 3.25rem;
|
||||
margin-bottom: 2rem;
|
||||
padding-bottom: 0.75rem;
|
||||
}
|
||||
#R-body-inner .chapter h3:first-of-type {
|
||||
margin-top: 2rem;
|
||||
}
|
||||
|
||||
/* Children shortcode */
|
||||
.children p,
|
||||
.children-li p,
|
||||
.children-h2 p,
|
||||
.children-h3 p {
|
||||
font-size: 1rem;
|
||||
}
|
||||
|
||||
.footline {
|
||||
/* in print mode show footer line to signal reader the end of document */
|
||||
border-top: 1px solid rgba(221, 221, 221, 1);
|
||||
color: rgba(119, 119, 119, 1);
|
||||
margin-top: 1.5rem;
|
||||
padding-top: 0.75rem;
|
||||
}
|
||||
|
||||
h1 + .footline {
|
||||
/* if we have no content in the page we remove the footer as it is of no real value in print */
|
||||
display: none;
|
||||
}
|
||||
|
||||
#R-body #R-body-inner .headline a,
|
||||
#R-body #R-body-inner .footline a,
|
||||
#R-body #R-body-inner .btn a {
|
||||
text-decoration: none;
|
||||
}
|
||||
#R-body #R-body-inner a {
|
||||
/* in print we want to distinguish links in our content from
|
||||
normal text even if printed black/white;
|
||||
don't use a.highlight in selector to also get links that are
|
||||
put as HTML into markdown */
|
||||
text-decoration-line: underline;
|
||||
}
|
||||
#R-topbar {
|
||||
/* the header is sticky which is not suitable for print; */
|
||||
position: initial;
|
||||
}
|
||||
#R-topbar > .topbar-wrapper {
|
||||
background-color: initial;
|
||||
}
|
||||
#R-body .topbar-sidebar-divider {
|
||||
border-width: 0;
|
||||
}
|
||||
article .R-taxonomy {
|
||||
display: none;
|
||||
}
|
||||
mark.search {
|
||||
background: inherit;
|
||||
color: inherit;
|
||||
}
|
||||
.mermaid.zoom:hover {
|
||||
border-color: transparent;
|
||||
}
|
||||
.box > .box-content {
|
||||
background-color: rgba(255, 255, 255, 1);
|
||||
}
|
||||
|
||||
.btn,
|
||||
#R-body .tab-nav-button {
|
||||
color: rgba(0, 0, 0, 1);
|
||||
}
|
||||
#R-body .tab-nav-button.active {
|
||||
border-bottom-color: rgba(255, 255, 255, 1);
|
||||
color: rgba(0, 0, 0, 1);
|
||||
}
|
||||
#R-body .tab-nav-button.active > .tab-nav-text {
|
||||
background-color: rgba(255, 255, 255, 1);
|
||||
}
|
||||
#R-body .tab-content-text {
|
||||
background-color: rgba(255, 255, 255, 1);
|
||||
color: rgba(0, 0, 0, 1);
|
||||
}
|
||||
|
||||
article {
|
||||
break-before: page;
|
||||
}
|
||||
#R-body-inner article:first-of-type {
|
||||
break-before: avoid;
|
||||
}
|
||||
|
||||
#R-body #R-body-inner .flex-block-wrapper {
|
||||
max-width: calc(var(--INTERNAL-MAIN-WIDTH-MAX) - var(--INTERNAL-MENU-WIDTH-L) - 2 * 3.25rem);
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
#R-body #R-body-inner > .flex-block-wrapper article.narrow > p {
|
||||
font-size: 1.015625rem;
|
||||
text-align: start;
|
||||
}
|
||||
|
||||
#R-body #R-body-inner > .flex-block-wrapper article.narrow > .article-subheading {
|
||||
margin-top: 0;
|
||||
}
|
||||
357
themes/hugo-theme-relearn/assets/css/nucleus.css
Normal file
357
themes/hugo-theme-relearn/assets/css/nucleus.css
Normal file
@@ -0,0 +1,357 @@
|
||||
*,
|
||||
*::before,
|
||||
*::after {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
@-webkit-viewport {
|
||||
width: device-width;
|
||||
}
|
||||
@-moz-viewport {
|
||||
width: device-width;
|
||||
}
|
||||
@-o-viewport {
|
||||
width: device-width;
|
||||
}
|
||||
@viewport {
|
||||
width: device-width;
|
||||
}
|
||||
html {
|
||||
font-size: 16px;
|
||||
-webkit-text-size-adjust: 100%;
|
||||
text-size-adjust: 100%;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
article,
|
||||
aside,
|
||||
details,
|
||||
figcaption,
|
||||
figure,
|
||||
footer,
|
||||
header,
|
||||
hgroup,
|
||||
main,
|
||||
nav,
|
||||
section,
|
||||
summary {
|
||||
display: block;
|
||||
}
|
||||
|
||||
audio,
|
||||
canvas,
|
||||
progress,
|
||||
video {
|
||||
display: inline-block;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
audio:not([controls]) {
|
||||
display: none;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
[hidden],
|
||||
template {
|
||||
display: none;
|
||||
}
|
||||
|
||||
a {
|
||||
background: transparent;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
abbr[title] {
|
||||
border-bottom: 1px dotted;
|
||||
}
|
||||
|
||||
dfn {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
sub,
|
||||
sup {
|
||||
font-size: 0.8rem;
|
||||
line-height: 0;
|
||||
position: relative;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
sup {
|
||||
top: -0.5em;
|
||||
}
|
||||
|
||||
sub {
|
||||
bottom: -0.25em;
|
||||
}
|
||||
|
||||
iframe {
|
||||
border: 0;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
svg:not(:root) {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
figure {
|
||||
margin: 1rem 2.5rem;
|
||||
}
|
||||
|
||||
hr {
|
||||
height: 0;
|
||||
}
|
||||
|
||||
pre:not(.mermaid) {
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
button,
|
||||
input,
|
||||
optgroup,
|
||||
select,
|
||||
textarea {
|
||||
color: inherit;
|
||||
font: inherit;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
button {
|
||||
overflow: visible;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
button,
|
||||
select {
|
||||
text-transform: none;
|
||||
}
|
||||
|
||||
button,
|
||||
html input[type='button'],
|
||||
input[type='reset'],
|
||||
input[type='submit'] {
|
||||
-webkit-appearance: button;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
button[disabled],
|
||||
html input[disabled] {
|
||||
cursor: default;
|
||||
}
|
||||
|
||||
button::-moz-focus-inner,
|
||||
input::-moz-focus-inner {
|
||||
border: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
input {
|
||||
line-height: normal;
|
||||
}
|
||||
|
||||
input[type='checkbox'],
|
||||
input[type='radio'] {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
input[type='number']::-webkit-inner-spin-button,
|
||||
input[type='number']::-webkit-outer-spin-button {
|
||||
height: auto;
|
||||
}
|
||||
|
||||
input[type='search'] {
|
||||
-webkit-appearance: textfield;
|
||||
}
|
||||
|
||||
input[type='search']::-webkit-search-cancel-button,
|
||||
input[type='search']::-webkit-search-decoration {
|
||||
-webkit-appearance: none;
|
||||
}
|
||||
|
||||
legend {
|
||||
border: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
textarea {
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
optgroup {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
table-layout: fixed;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
tr,
|
||||
td,
|
||||
th {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
th,
|
||||
td {
|
||||
padding: 0.425rem 0;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: start;
|
||||
}
|
||||
|
||||
p {
|
||||
margin: 1rem 0;
|
||||
}
|
||||
|
||||
ul,
|
||||
ol {
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
ul ul,
|
||||
ul ol,
|
||||
ol ul,
|
||||
ol ol {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: 1.5rem 0;
|
||||
padding-inline-start: 0.85rem;
|
||||
}
|
||||
|
||||
cite {
|
||||
display: block;
|
||||
font-size: 0.925rem;
|
||||
}
|
||||
cite:before {
|
||||
content: '\2014 \0020';
|
||||
}
|
||||
|
||||
pre:not(.mermaid) {
|
||||
margin: 1.5rem 0;
|
||||
padding: 0.938rem;
|
||||
}
|
||||
|
||||
code {
|
||||
vertical-align: bottom;
|
||||
}
|
||||
|
||||
small {
|
||||
font-size: 0.925rem;
|
||||
}
|
||||
|
||||
hr {
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
border-top: none;
|
||||
margin: 1.5rem 0;
|
||||
}
|
||||
|
||||
fieldset {
|
||||
border: 0;
|
||||
padding: 0.938rem;
|
||||
margin: 0 0 1rem 0;
|
||||
}
|
||||
|
||||
input,
|
||||
label,
|
||||
select {
|
||||
display: block;
|
||||
}
|
||||
|
||||
label {
|
||||
margin-bottom: 0.425rem;
|
||||
}
|
||||
label.required:after {
|
||||
content: '*';
|
||||
}
|
||||
label abbr {
|
||||
display: none;
|
||||
}
|
||||
|
||||
textarea,
|
||||
input[type='email'],
|
||||
input[type='number'],
|
||||
input[type='password'],
|
||||
input[type='search'],
|
||||
input[type='tel'],
|
||||
input[type='text'],
|
||||
input[type='url'],
|
||||
input[type='color'],
|
||||
input[type='date'],
|
||||
input[type='datetime'],
|
||||
input[type='datetime-local'],
|
||||
input[type='month'],
|
||||
input[type='time'],
|
||||
input[type='week'],
|
||||
select[multiple='multiple'] {
|
||||
-webkit-transition: border-color;
|
||||
-moz-transition: border-color;
|
||||
transition: border-color;
|
||||
border-radius: 0.1875rem;
|
||||
margin-bottom: 0.85rem;
|
||||
padding: 0.425rem 0.425rem;
|
||||
width: 100%;
|
||||
}
|
||||
textarea:focus,
|
||||
input[type='email']:focus,
|
||||
input[type='number']:focus,
|
||||
input[type='password']:focus,
|
||||
input[type='search']:focus,
|
||||
input[type='tel']:focus,
|
||||
input[type='text']:focus,
|
||||
input[type='url']:focus,
|
||||
input[type='color']:focus,
|
||||
input[type='date']:focus,
|
||||
input[type='datetime']:focus,
|
||||
input[type='datetime-local']:focus,
|
||||
input[type='month']:focus,
|
||||
input[type='time']:focus,
|
||||
input[type='week']:focus,
|
||||
select[multiple='multiple']:focus {
|
||||
outline: none;
|
||||
}
|
||||
|
||||
textarea {
|
||||
resize: vertical;
|
||||
}
|
||||
|
||||
input[type='checkbox'],
|
||||
input[type='radio'] {
|
||||
display: inline;
|
||||
margin-inline-end: 0.425rem;
|
||||
}
|
||||
|
||||
input[type='file'] {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
select {
|
||||
width: auto;
|
||||
max-width: 100%;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
button,
|
||||
input[type='submit'] {
|
||||
cursor: pointer;
|
||||
-webkit-user-select: none;
|
||||
user-select: none;
|
||||
white-space: nowrap;
|
||||
border: inherit;
|
||||
}
|
||||
411
themes/hugo-theme-relearn/assets/css/swagger.css
Normal file
411
themes/hugo-theme-relearn/assets/css/swagger.css
Normal file
@@ -0,0 +1,411 @@
|
||||
body {
|
||||
line-height: 1.574;
|
||||
font-variation-settings: var(--INTERNAL-MAIN-font-variation-settings);
|
||||
font-weight: var(--INTERNAL-MAIN-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-letter-spacing);
|
||||
margin: 0;
|
||||
overflow: hidden;
|
||||
}
|
||||
body,
|
||||
.swagger-ui .info *,
|
||||
#relearn-swagger-ui .renderedMarkdown *,
|
||||
#relearn-swagger-ui p {
|
||||
font-size: 1.015625rem;
|
||||
}
|
||||
.swagger-ui .scheme-container {
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
}
|
||||
.swagger-ui .wrapper {
|
||||
padding-left: 0;
|
||||
padding-right: 0;
|
||||
}
|
||||
h2 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H2-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H2-font-variation-settings);
|
||||
font-weight: var(--INTERNAL-MAIN-TITLES-H2-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H2-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H2-letter-spacing);
|
||||
}
|
||||
svg {
|
||||
fill: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .info h2.title {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H2-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H2-font-variation-settings);
|
||||
font-weight: var(--INTERNAL-MAIN-TITLES-H2-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H2-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H2-letter-spacing);
|
||||
}
|
||||
.relearn-expander {
|
||||
display: block;
|
||||
float: right;
|
||||
margin: 0.5rem;
|
||||
}
|
||||
#relearn-swagger-ui {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* Styles extracted from swagger-dark.css generated by Dark Reader */
|
||||
|
||||
html {
|
||||
background-color: var(--INTERNAL-MAIN-BG-color) !important;
|
||||
color-scheme: var(--INTERNAL-BROWSER-theme) !important;
|
||||
}
|
||||
html,
|
||||
body {
|
||||
background-color: var(--INTERNAL-MAIN-BG-color);
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
a {
|
||||
color: var(--INTERNAL-MAIN-LINK-color);
|
||||
}
|
||||
input:-webkit-autofill,
|
||||
textarea:-webkit-autofill,
|
||||
select:-webkit-autofill {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color) !important;
|
||||
}
|
||||
::-webkit-scrollbar-corner {
|
||||
background-color: var(--INTERNAL-MAIN-BG-color);
|
||||
}
|
||||
::selection {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color) !important;
|
||||
}
|
||||
::-moz-selection {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color) !important;
|
||||
}
|
||||
*:not(pre, pre *, code, .far, .fa, .glyphicon, [class*='vjs-'], .fab, .fa-github, .fas, .material-icons, .icofont, .typcn, mu, [class*='mu-'], .glyphicon, .icon) {
|
||||
font-variation-settings: var(--INTERNAL-MAIN-font-variation-settings);
|
||||
font-family: var(--INTERNAL-MAIN-font) !important;
|
||||
letter-spacing: var(--INTERNAL-MAIN-letter-spacing) !important;
|
||||
line-height: 1.574 !important;
|
||||
}
|
||||
:root {
|
||||
--darkreader-neutral-background: var(--INTERNAL-MAIN-BG-color);
|
||||
--darkreader-neutral-text: var(--INTERNAL-MAIN-TEXT-color);
|
||||
--darkreader-selection-text: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .nested-links a {
|
||||
color: var(--INTERNAL-MAIN-LINK-color);
|
||||
}
|
||||
.swagger-ui .nested-links a:focus,
|
||||
.swagger-ui .nested-links a:hover {
|
||||
color: var(--INTERNAL-MAIN-LINK-HOVER-color);
|
||||
}
|
||||
.swagger-ui .opblock-tag {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock-tag small {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .parameter__type {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock .opblock-section-header > label {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock .opblock-section-header h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui .opblock .opblock-summary-operation-id,
|
||||
.swagger-ui .opblock .opblock-summary-path,
|
||||
.swagger-ui .opblock .opblock-summary-path__deprecated {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock .opblock-summary-description {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-post {
|
||||
border-color: var(--INTERNAL-BOX-GREEN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-post .opblock-summary-method {
|
||||
background-color: var(--INTERNAL-BOX-GREEN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-post .opblock-summary {
|
||||
border-color: var(--INTERNAL-BOX-GREEN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-post .tab-header .tab-item.active h4 span::after {
|
||||
background-color: var(--INTERNAL-BOX-GREEN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-put {
|
||||
border-color: var(--INTERNAL-BOX-ORANGE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-put .opblock-summary-method {
|
||||
background-color: var(--INTERNAL-BOX-ORANGE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-put .opblock-summary {
|
||||
border-color: var(--INTERNAL-BOX-ORANGE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-put .tab-header .tab-item.active h4 span::after {
|
||||
background-color: var(--INTERNAL-BOX-ORANGE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-delete {
|
||||
border-color: var(--INTERNAL-BOX-RED-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-delete .opblock-summary-method {
|
||||
background-color: var(--INTERNAL-BOX-RED-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-delete .opblock-summary {
|
||||
border-color: var(--INTERNAL-BOX-RED-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-delete .tab-header .tab-item.active h4 span::after {
|
||||
background-color: var(--INTERNAL-BOX-RED-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-get {
|
||||
border-color: var(--INTERNAL-BOX-BLUE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-get .opblock-summary-method {
|
||||
background-color: var(--INTERNAL-BOX-BLUE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-get .opblock-summary {
|
||||
border-color: var(--INTERNAL-BOX-BLUE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-get .tab-header .tab-item.active h4 span::after {
|
||||
background-color: var(--INTERNAL-BOX-BLUE-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-patch {
|
||||
border-color: var(--INTERNAL-BOX-CYAN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-patch .opblock-summary-method {
|
||||
background-color: var(--INTERNAL-BOX-CYAN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-patch .opblock-summary {
|
||||
border-color: var(--INTERNAL-BOX-CYAN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-patch .tab-header .tab-item.active h4 span::after {
|
||||
background-color: var(--INTERNAL-BOX-CYAN-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-options {
|
||||
border-color: var(--INTERNAL-BOX-MAGENTA-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-options .opblock-summary-method {
|
||||
background-color: var(--INTERNAL-BOX-MAGENTA-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-options .opblock-summary {
|
||||
border-color: var(--INTERNAL-BOX-MAGENTA-color);
|
||||
}
|
||||
.swagger-ui .opblock.opblock-options .tab-header .tab-item.active h4 span::after {
|
||||
background-color: var(--INTERNAL-BOX-MAGENTA-color);
|
||||
}
|
||||
.swagger-ui .tab li {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock-description-wrapper,
|
||||
.swagger-ui .opblock-external-docs-wrapper,
|
||||
.swagger-ui .opblock-title_normal {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock-description-wrapper h4,
|
||||
.swagger-ui .opblock-external-docs-wrapper h4,
|
||||
.swagger-ui .opblock-title_normal h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui .opblock-description-wrapper p,
|
||||
.swagger-ui .opblock-external-docs-wrapper p,
|
||||
.swagger-ui .opblock-title_normal p {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .responses-inner h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui .responses-inner h5 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H5-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H5-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H5-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H5-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H5-letter-spacing);
|
||||
}
|
||||
.swagger-ui .response-col_status {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .response-col_links {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .opblock-body pre.microlight {
|
||||
background-color: var(--INTERNAL-MAIN-BG-color);
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .scheme-container .schemes > label {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .loading-container .loading::after {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui section h3 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H3-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H3-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H3-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H3-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H3-letter-spacing);
|
||||
}
|
||||
.swagger-ui .btn {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui select {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui label {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui textarea {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .checkbox p {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .dialog-ux .modal-ux-content p {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .dialog-ux .modal-ux-content h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui .dialog-ux .modal-ux-header h3 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H3-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H3-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H3-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H3-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H3-letter-spacing);
|
||||
}
|
||||
.swagger-ui .model {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui section.models h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui section.models h5 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H5-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H5-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H5-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H5-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H5-letter-spacing);
|
||||
}
|
||||
.swagger-ui .model-title {
|
||||
color: var(--INTERNAL-MAIN-TITLES-TEXT-color);
|
||||
}
|
||||
.swagger-ui .prop-format {
|
||||
color: var(--INTERNAL-MAIN-TITLES-TEXT-color);
|
||||
}
|
||||
.swagger-ui .servers > label {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui table.headers td {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui table thead tr td,
|
||||
.swagger-ui table thead tr th {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .parameter__name {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .info li,
|
||||
.swagger-ui .info p,
|
||||
.swagger-ui .info table {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .info h1 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H1-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H1-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H1-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H1-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H1-letter-spacing);
|
||||
text-align: center;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
.swagger-ui .info h2 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H2-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H2-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H2-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H2-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H2-letter-spacing);
|
||||
}
|
||||
.swagger-ui .info h3 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H3-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H3-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H3-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H3-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H3-letter-spacing);
|
||||
}
|
||||
.swagger-ui .info h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui .info h5 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H5-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H5-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H5-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H5-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H5-letter-spacing);
|
||||
}
|
||||
.swagger-ui .info a {
|
||||
color: var(--INTERNAL-MAIN-LINK-color);
|
||||
}
|
||||
.swagger-ui .info a:hover {
|
||||
color: var(--INTERNAL-MAIN-LINK-HOVER-color);
|
||||
}
|
||||
.swagger-ui .info .base-url {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .info .title {
|
||||
color: var(--INTERNAL-MAIN-TITLES-TEXT-color);
|
||||
}
|
||||
.swagger-ui .auth-container .errors {
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
.swagger-ui .scopes h2 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H2-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H2-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H2-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H2-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H2-letter-spacing);
|
||||
}
|
||||
.swagger-ui .scopes h2 a {
|
||||
color: var(--INTERNAL-MAIN-LINK-color);
|
||||
}
|
||||
.swagger-ui .errors-wrapper .errors h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
.swagger-ui .errors-wrapper .errors small {
|
||||
color: var(--INTERNAL-MAIN-TITLES-TEXT-color);
|
||||
}
|
||||
.swagger-ui .errors-wrapper hgroup h4 {
|
||||
color: var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
font-variation-settings: var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings);
|
||||
!font-weight: var(--INTERNAL-MAIN-TITLES-H4-font-weight);
|
||||
font-family: var(--INTERNAL-MAIN-TITLES-H4-font);
|
||||
letter-spacing: var(--INTERNAL-MAIN-TITLES-H4-letter-spacing);
|
||||
}
|
||||
body {
|
||||
background-color: var(--INTERNAL-MAIN-BG-color);
|
||||
}
|
||||
43
themes/hugo-theme-relearn/assets/css/theme-blue.css
Normal file
43
themes/hugo-theme-relearn/assets/css/theme-blue.css
Normal file
@@ -0,0 +1,43 @@
|
||||
:root {
|
||||
/* blue */
|
||||
--MAIN-TEXT-color: rgba(50, 50, 50, 1); /* Color of text by default */
|
||||
--MAIN-TITLES-TEXT-color: rgba(94, 94, 94, 1); /* Color of titles h2-h3-h4-h5-h6 */
|
||||
--MAIN-TITLES-H1-TEXT-color: rgba(34, 34, 34, 1); /* text color of h1 titles */
|
||||
--MAIN-LINK-color: rgba(28, 144, 243, 1); /* Color of links */
|
||||
--MAIN-LINK-HOVER-color: rgba(22, 122, 208, 1); /* Color of hovered links */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* color of text by default */
|
||||
|
||||
--CODE-theme: learn; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(226, 228, 229, 1); /* fallback color for code text */
|
||||
--CODE-BLOCK-BG-color: rgba(40, 42, 54, 1); /* fallback color for code background */
|
||||
--CODE-BLOCK-BORDER-color: rgba(40, 42, 54, 1); /* color of block code border */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* color for inline code text */
|
||||
--CODE-INLINE-BG-color: rgba(255, 250, 233, 1); /* color for inline code background */
|
||||
--CODE-INLINE-BORDER-color: rgba(248, 232, 200, 1); /* color of inline code border */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(45, 54, 63, 1); /* Color of the home button text */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(0, 0, 0, 1); /* Color of the hovered home button text */
|
||||
|
||||
--MENU-HEADER-color: rgba(255, 255, 255, 1); /* color of menu header */
|
||||
--MENU-HEADER-BG-color: rgba(28, 144, 243, 1); /* Background color of menu header */
|
||||
--MENU-HEADER-BORDER-color: rgba(51, 161, 255, 1); /*Color of menu header border */
|
||||
|
||||
--MENU-SEARCH-color: rgba(255, 255, 255, 1); /* Color of search field text */
|
||||
--MENU-SEARCH-BG-color: rgba(22, 122, 208, 1); /* Search field background color (by default borders + icons) */
|
||||
--MENU-SEARCH-BORDER-color: rgba(51, 161, 255, 1); /* Override search field border color */
|
||||
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(32, 39, 43, 1); /* Background color of the active section and its children */
|
||||
--MENU-SECTIONS-BG-color: rgba(37, 44, 49, 1); /* Background color of other sections */
|
||||
--MENU-SECTIONS-LINK-color: rgba(204, 204, 204, 1); /* Color of links in menu */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(230, 230, 230, 1); /* Color of links in menu, when hovered */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(119, 119, 119, 1); /* Color of active category text */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba(255, 255, 255, 1); /* Color of background for the active category (only) */
|
||||
|
||||
--MENU-VISITED-color: rgba(28, 144, 243, 1); /* Color of 'page visited' icons in menu */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(32, 39, 43, 1); /* Color of <hr> separator in menu */
|
||||
|
||||
/* base styling for boxes */
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* color of the title text */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* color of the content background */
|
||||
--BOX-TEXT-color: rgba(16, 16, 16, 1); /* fixed color of the content text */
|
||||
}
|
||||
43
themes/hugo-theme-relearn/assets/css/theme-green.css
Normal file
43
themes/hugo-theme-relearn/assets/css/theme-green.css
Normal file
@@ -0,0 +1,43 @@
|
||||
:root {
|
||||
/* green */
|
||||
--MAIN-TEXT-color: rgba(50, 50, 50, 1); /* Color of text by default */
|
||||
--MAIN-TITLES-TEXT-color: rgba(94, 94, 94, 1); /* Color of titles h2-h3-h4-h5-h6 */
|
||||
--MAIN-TITLES-H1-TEXT-color: rgba(34, 34, 34, 1); /* text color of h1 titles */
|
||||
--MAIN-LINK-color: rgba(89, 154, 62, 1); /* Color of links */
|
||||
--MAIN-LINK-HOVER-color: rgba(63, 109, 44, 1); /* Color of hovered links */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* color of text by default */
|
||||
|
||||
--CODE-theme: learn; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(226, 228, 229, 1); /* fallback color for code text */
|
||||
--CODE-BLOCK-BG-color: rgba(40, 42, 54, 1); /* fallback color for code background */
|
||||
--CODE-BLOCK-BORDER-color: rgba(40, 42, 54, 1); /* color of block code border */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* color for inline code text */
|
||||
--CODE-INLINE-BG-color: rgba(255, 250, 233, 1); /* color for inline code background */
|
||||
--CODE-INLINE-BORDER-color: rgba(248, 232, 200, 1); /* color of inline code border */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(46, 59, 46, 1); /* Color of the home button text */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(0, 0, 0, 1); /* Color of the hovered home button text */
|
||||
|
||||
--MENU-HEADER-color: rgba(255, 255, 255, 1); /* color of menu header */
|
||||
--MENU-HEADER-BG-color: rgba(116, 181, 89, 1); /* Background color of menu header */
|
||||
--MENU-HEADER-BORDER-color: rgba(156, 212, 132, 1); /*Color of menu header border */
|
||||
|
||||
--MENU-SEARCH-color: rgba(255, 255, 255, 1); /* Color of search field text */
|
||||
--MENU-SEARCH-BG-color: rgba(89, 154, 62, 1); /* Search field background color (by default borders + icons) */
|
||||
--MENU-SEARCH-BORDER-color: rgba(132, 199, 103, 1); /* Override search field border color */
|
||||
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(27, 33, 28, 1); /* Background color of the active section and its children */
|
||||
--MENU-SECTIONS-BG-color: rgba(34, 39, 35, 1); /* Background color of other sections */
|
||||
--MENU-SECTIONS-LINK-color: rgba(204, 204, 204, 1); /* Color of links in menu */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(230, 230, 230, 1); /* Color of links in menu, when hovered */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(119, 119, 119, 1); /* Color of active category text */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba(255, 255, 255, 1); /* Color of background for the active category (only) */
|
||||
|
||||
--MENU-VISITED-color: rgba(89, 154, 62, 1); /* Color of 'page visited' icons in menu */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(24, 33, 28, 1); /* Color of <hr> separator in menu */
|
||||
|
||||
/* base styling for boxes */
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* color of the title text */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* color of the content background */
|
||||
--BOX-TEXT-color: rgba(16, 16, 16, 1); /* fixed color of the content text */
|
||||
}
|
||||
43
themes/hugo-theme-relearn/assets/css/theme-learn.css
Normal file
43
themes/hugo-theme-relearn/assets/css/theme-learn.css
Normal file
@@ -0,0 +1,43 @@
|
||||
:root {
|
||||
/* learn */
|
||||
--MAIN-TEXT-color: rgba(50, 50, 50, 1); /* Color of text by default */
|
||||
--MAIN-TITLES-TEXT-color: rgba(94, 94, 94, 1); /* Color of titles h2-h3-h4-h5-h6 */
|
||||
--MAIN-TITLES-H1-TEXT-color: rgba(34, 34, 34, 1); /* text color of h1 titles */
|
||||
--MAIN-LINK-color: rgba(0, 189, 243, 1); /* Color of links */
|
||||
--MAIN-LINK-HOVER-color: rgba(0, 130, 167, 1); /* Color of hovered links */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* color of text by default */
|
||||
|
||||
--CODE-theme: learn; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(226, 228, 229, 1); /* fallback color for code text */
|
||||
--CODE-BLOCK-BG-color: rgba(40, 42, 54, 1); /* fallback color for code background */
|
||||
--CODE-BLOCK-BORDER-color: rgba(40, 42, 54, 1); /* color of block code border */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* color for inline code text */
|
||||
--CODE-INLINE-BG-color: rgba(255, 247, 221, 1); /* color for inline code background */
|
||||
--CODE-INLINE-BORDER-color: rgba(251, 240, 203, 1); /* color of inline code border */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(224, 224, 224, 1); /* Color of the home button text */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(240, 240, 240, 1); /* Color of the hovered home button text */
|
||||
|
||||
--MENU-HEADER-color: rgba(255, 255, 255, 1); /* color of menu header */
|
||||
--MENU-HEADER-BG-color: rgba(132, 81, 161, 1); /* Background color of menu header */
|
||||
--MENU-HEADER-BORDER-color: rgba(156, 111, 182, 1); /*Color of menu header border */
|
||||
|
||||
--MENU-SEARCH-color: rgba(255, 255, 255, 1); /* Color of search field text */
|
||||
--MENU-SEARCH-BG-color: rgba(118, 72, 144, 1); /* Search field background color (by default borders + icons) */
|
||||
--MENU-SEARCH-BORDER-color: rgba(145, 94, 174, 1); /* Override search field border color */
|
||||
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(37, 31, 41, 1); /* Background color of the active section and its children */
|
||||
--MENU-SECTIONS-BG-color: rgba(50, 42, 56, 1); /* Background color of other sections */
|
||||
--MENU-SECTIONS-LINK-color: rgba(204, 204, 204, 1); /* Color of links in menu */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(230, 230, 230, 1); /* Color of links in menu, when hovered */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(119, 119, 119, 1); /* Color of active category text */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba(255, 255, 255, 1); /* Color of background for the active category (only) */
|
||||
|
||||
--MENU-VISITED-color: rgba(0, 189, 243, 1); /* Color of 'page visited' icons in menu */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(42, 35, 47, 1); /* Color of <hr> separator in menu */
|
||||
|
||||
/* base styling for boxes */
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* color of the title text */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* color of the content background */
|
||||
--BOX-TEXT-color: rgba(16, 16, 16, 1); /* fixed color of the content text */
|
||||
}
|
||||
265
themes/hugo-theme-relearn/assets/css/theme-neon.css
Normal file
265
themes/hugo-theme-relearn/assets/css/theme-neon.css
Normal file
@@ -0,0 +1,265 @@
|
||||
:root {
|
||||
/* neon */
|
||||
--PRIMARY-color: rgba(243, 0, 178, 1); /* brand primary color */
|
||||
--SECONDARY-color: rgb(50, 189, 243, 1); /* brand secondary color */
|
||||
--ACCENT-color: rgba(255, 255, 0, 1); /* brand accent color, used for search highlights */
|
||||
|
||||
--MAIN-TEXT-color: rgba(224, 224, 224, 1); /* text color of content and h1 titles */
|
||||
--MAIN-LINK-HOVER-color: rgb(80, 215, 255, 1); /* hovered link color of content */
|
||||
--MAIN-BG-color: rgba(16, 16, 16, 1); /* background color of content */
|
||||
|
||||
/* optional overwrites for specific headers */
|
||||
--MAIN-TITLES-TEXT-color: rgba(243, 0, 178, 1); /* text color of h2-h6 titles and transparent box titles */
|
||||
--MAIN-TITLES-H3-TEXT-color: rgba(255, 255, 0, 1); /* text color of h3-h6 titles */
|
||||
--MAIN-TITLES-H4-TEXT-color: rgba(154, 111, 255, 1); /* text color of h4-h6 titles */
|
||||
|
||||
--CODE-theme: neon; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(248, 248, 242, 1); /* fallback text color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BG-color: rgba(0, 0, 0, 1); /* fallback background color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-INLINE-color: rgba(130, 229, 80, 1); /* text color of inline code */
|
||||
--CODE-INLINE-BG-color: rgba(40, 42, 54, 1); /* background color of inline code */
|
||||
--CODE-INLINE-BORDER-color: rgba(70, 70, 70, 1); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: tomorrow-night; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HEADER-color: rgba(255, 255, 255, 1); /* color of menu header */
|
||||
--MENU-HEADER-BG-color: rgba(0, 0, 0, 0); /* background color of menu header */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(255, 255, 255, 1); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(208, 208, 208, 1); /* hovered home button color if configured */
|
||||
|
||||
--MENU-SEARCH-color: rgba(248, 248, 248, 1); /* text and icon color of search box */
|
||||
--MENU-SEARCH-BG-color: rgba(16, 16, 16, 0.6); /* background color of search box */
|
||||
--MENU-SEARCH-BORDER-color: rgba(232, 232, 232, 1); /* border color of search box */
|
||||
|
||||
--MENU-SECTIONS-BG-color: linear-gradient(165deg, rgba(243, 0, 178, 0.825) 0%, rgba(28, 144, 243, 0.7) 65%, rgba(0, 227, 211, 0.7) 100%); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(0, 0, 0, 0.166); /* background color of the active menu section */
|
||||
--MENU-SECTIONS-LINK-color: rgba(255, 255, 255, 1); /* link color of menu topics */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(208, 208, 208, 1); /* hovered link color of menu topics */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(86, 255, 232, 1); /* text color of the displayed menu topic */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(186, 186, 186, 1); /* separator color between menu sections and menu footer */
|
||||
|
||||
--MENU-VISITED-color: rgba(51, 161, 255, 1); /* icon color of visited menu topics if configured */
|
||||
|
||||
/* base styling for boxes */
|
||||
--BOX-CAPTION-color: rgba(240, 240, 240, 1); /* text color of colored box titles */
|
||||
--BOX-BG-color: rgba(8, 8, 8, 1); /* background color of colored boxes */
|
||||
--BOX-TEXT-color: initial; /* text color of colored box content */
|
||||
|
||||
/* optional base colors for colored boxes as in badges, buttons, notice, etc. shortcode */
|
||||
--BOX-BLUE-color: rgba(48, 117, 229, 1); /* background color of blue boxes */
|
||||
--BOX-BLUE-TEXT-color: var(--BOX-BLUE-color); /* text color of blue boxes */
|
||||
--BOX-CYAN-color: rgba(30, 190, 190, 1); /* background color of cyan boxes */
|
||||
--BOX-CYAN-TEXT-color: var(--BOX-CYAN-color); /* text color of cyan boxes */
|
||||
--BOX-GREEN-color: rgba(42, 178, 24, 1); /* background color of green boxes */
|
||||
--BOX-GREEN-TEXT-color: var(--BOX-GREEN-color); /* text color of green boxes */
|
||||
--BOX-GREY-color: rgba(128, 128, 128, 1); /* background color of grey boxes */
|
||||
--BOX-GREY-TEXT-color: var(--BOX-GREY-color); /* text color of grey boxes */
|
||||
--BOX-MAGENTA-color: rgba(237, 33, 220, 1); /* background color of magenta boxes */
|
||||
--BOX-MAGENTA-TEXT-color: var(--BOX-MAGENTA-color); /* text color of magenta boxes */
|
||||
--BOX-ORANGE-color: rgba(237, 153, 9, 1); /* background color of orange boxes */
|
||||
--BOX-ORANGE-TEXT-color: var(--BOX-ORANGE-color); /* text color of orange boxes */
|
||||
--BOX-RED-color: rgba(224, 62, 62, 1); /* background color of red boxes */
|
||||
--BOX-RED-TEXT-color: var(--BOX-RED-color); /* text color of red boxes */
|
||||
}
|
||||
|
||||
body a#R-logo {
|
||||
text-shadow:
|
||||
0 0 1px var(--INTERNAL-MENU-SEARCH-BORDER-color),
|
||||
0 0 2px var(--INTERNAL-MENU-SEARCH-BORDER-color),
|
||||
0 0 4px var(--INTERNAL-MENU-SEARCH-BORDER-color),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color),
|
||||
0 0 8px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color);
|
||||
}
|
||||
|
||||
body h1,
|
||||
body h1 * {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 4px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(255, 255, 255, 1),
|
||||
0 0 3px var(--INTERNAL-MAIN-TITLES-H1-TEXT-color),
|
||||
0 0 6px var(--INTERNAL-MAIN-TITLES-H1-TEXT-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-TITLES-H1-TEXT-color);
|
||||
}
|
||||
|
||||
body h2,
|
||||
body h2 * {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MAIN-TITLES-H2-TEXT-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-TITLES-H2-TEXT-color),
|
||||
0 0 10px var(--INTERNAL-MAIN-TITLES-H2-TEXT-color);
|
||||
}
|
||||
|
||||
body h3,
|
||||
body h3 *,
|
||||
body .article-subheading {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MAIN-TITLES-H3-TEXT-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-TITLES-H3-TEXT-color),
|
||||
0 0 10px var(--INTERNAL-MAIN-TITLES-H3-TEXT-color);
|
||||
}
|
||||
|
||||
body h4,
|
||||
body h4 * {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MAIN-TITLES-H4-TEXT-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-TITLES-H4-TEXT-color),
|
||||
0 0 10px var(--INTERNAL-MAIN-TITLES-H4-TEXT-color);
|
||||
}
|
||||
|
||||
body h5,
|
||||
body h5 * {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 3px rgba(255, 255, 255, 1),
|
||||
0 0 6px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MAIN-TITLES-H5-TEXT-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-TITLES-H5-TEXT-color);
|
||||
}
|
||||
|
||||
body h6,
|
||||
body h6 * {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 4px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MAIN-TITLES-H6-TEXT-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-TITLES-H6-TEXT-color);
|
||||
}
|
||||
|
||||
body h1 a,
|
||||
body h2 a,
|
||||
body h3 a,
|
||||
body h4 a,
|
||||
body h5 a,
|
||||
body h6 a,
|
||||
body [id] > button.anchor i {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MAIN-LINK-color),
|
||||
0 0 8px var(--INTERNAL-MAIN-LINK-color),
|
||||
0 0 10px var(--INTERNAL-MAIN-LINK-color);
|
||||
}
|
||||
|
||||
.swagger-ui h1,
|
||||
.swagger-ui h2,
|
||||
.swagger-ui h3,
|
||||
.swagger-ui h4,
|
||||
.swagger-ui h5,
|
||||
.swagger-ui h6 {
|
||||
color: rgba(255, 255, 255, 1) !important;
|
||||
}
|
||||
|
||||
body #R-sidebar .searchbox button:hover {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MENU-SEARCH-color),
|
||||
0 0 8px var(--INTERNAL-MENU-SEARCH-color);
|
||||
}
|
||||
|
||||
body #R-sidebar select:hover,
|
||||
body #R-sidebar .collapsible-menu li:not(.active) > label:hover,
|
||||
body #R-sidebar .menu-control:hover,
|
||||
body #R-sidebar a:hover,
|
||||
body #R-prefooter button:hover {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color),
|
||||
0 0 8px var(--INTERNAL-MENU-SECTIONS-LINK-HOVER-color);
|
||||
}
|
||||
|
||||
body #R-sidebar li.active > label,
|
||||
body #R-sidebar li.active > :is(a, span) {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color),
|
||||
0 0 8px var(--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color);
|
||||
}
|
||||
|
||||
body #R-homelinks.homelinks a:hover {
|
||||
color: rgba(255, 255, 255, 1);
|
||||
text-shadow:
|
||||
0 0 1px rgba(255, 255, 255, 1),
|
||||
0 0 2px rgba(255, 255, 255, 1),
|
||||
0 0 8px rgba(128, 128, 128, 1),
|
||||
0 0 4px var(--INTERNAL-MENU-HOME-LINK-HOVER-color),
|
||||
0 0 8px var(--INTERNAL-MENU-HOME-LINK-HOVER-color);
|
||||
}
|
||||
|
||||
body .badge,
|
||||
body .btn,
|
||||
body .box:not(.cstyle.transparent) {
|
||||
box-shadow: 0 0 1px rgba(255, 255, 255, 1), 0 0 2px rgba(255, 255, 255, 1), 0 0 4px rgba(128, 128, 128, 1), 0 0 4px var(--VARIABLE-BOX-color);
|
||||
}
|
||||
|
||||
body .badge > .badge-content,
|
||||
body .btn,
|
||||
body .btn > *,
|
||||
body .box:not(.cstyle.transparent) > .box-label {
|
||||
text-shadow: 0 0 1px rgba(255, 255, 255, 1), 0 0 2px rgba(255, 255, 255, 1), 0 0 4px rgba(128, 128, 128, 1), 0 0 4px var(--VARIABLE-BOX-CAPTION-color);
|
||||
}
|
||||
|
||||
body .tab-panel-cstyle:not(.transparent),
|
||||
body .badge.cstyle:not(.transparent),
|
||||
body .btn.cstyle {
|
||||
--VARIABLE-BOX-TEXT-color: var(--VARIABLE-BOX-CAPTION-color);
|
||||
}
|
||||
|
||||
body .badge.cstyle.transparent,
|
||||
body .btn.cstyle.transparent {
|
||||
--VARIABLE-BOX-BG-color: var(--INTERNAL-BOX-BG-color);
|
||||
}
|
||||
|
||||
body .btn.cstyle.transparent > * {
|
||||
border-color: var(--VARIABLE-BOX-color);
|
||||
color: var(--VARIABLE-BOX-CAPTION-color);
|
||||
}
|
||||
|
||||
body .btn.cstyle.interactive.transparent > *:hover,
|
||||
body .btn.cstyle.interactive.transparent > *:active,
|
||||
body .btn.cstyle.interactive.transparent > *:focus {
|
||||
background-color: var(--INTERNAL-MAIN-TITLES-TEXT-color);
|
||||
color: var(--INTERNAL-MAIN-TEXT-color);
|
||||
}
|
||||
|
||||
body .box.cstyle.transparent {
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
#R-content-wrapper {
|
||||
--ps-thumb-color: rgba(208, 208, 208, 1);
|
||||
--ps-thumb-hover-color: rgba(204, 204, 204, 1);
|
||||
}
|
||||
43
themes/hugo-theme-relearn/assets/css/theme-red.css
Normal file
43
themes/hugo-theme-relearn/assets/css/theme-red.css
Normal file
@@ -0,0 +1,43 @@
|
||||
:root {
|
||||
/* red */
|
||||
--MAIN-TEXT-color: rgba(50, 50, 50, 1); /* Color of text by default */
|
||||
--MAIN-TITLES-TEXT-color: rgba(94, 94, 94, 1); /* Color of titles h2-h3-h4-h5-h6 */
|
||||
--MAIN-TITLES-H1-TEXT-color: rgba(34, 34, 34, 1); /* text color of h1 titles */
|
||||
--MAIN-LINK-color: rgba(243, 28, 28, 1); /* Color of links */
|
||||
--MAIN-LINK-HOVER-color: rgba(208, 22, 22, 1); /* Color of hovered links */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* color of text by default */
|
||||
|
||||
--CODE-theme: learn; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(226, 228, 229, 1); /* fallback color for code text */
|
||||
--CODE-BLOCK-BG-color: rgba(40, 42, 54, 1); /* fallback color for code background */
|
||||
--CODE-BLOCK-BORDER-color: rgba(40, 42, 54, 1); /* color of block code border */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* color for inline code text */
|
||||
--CODE-INLINE-BG-color: rgba(255, 250, 233, 1); /* color for inline code background */
|
||||
--CODE-INLINE-BORDER-color: rgba(248, 232, 200, 1); /* color of inline code border */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(56, 43, 43, 1); /* Color of the home button text */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(0, 0, 0, 1); /* Color of the hovered home button text */
|
||||
|
||||
--MENU-HEADER-color: rgba(255, 255, 255, 1); /* color of menu header */
|
||||
--MENU-HEADER-BG-color: rgba(220, 16, 16, 1); /* Background color of menu header */
|
||||
--MENU-HEADER-BORDER-color: rgba(226, 49, 49, 1); /*Color of menu header border */
|
||||
|
||||
--MENU-SEARCH-color: rgba(255, 255, 255, 1); /* Color of search field text */
|
||||
--MENU-SEARCH-BG-color: rgba(185, 0, 0, 1); /* Search field background color (by default borders + icons) */
|
||||
--MENU-SEARCH-BORDER-color: rgba(239, 32, 32, 1); /* Override search field border color */
|
||||
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(43, 32, 32, 1); /* Background color of the active section and its children */
|
||||
--MENU-SECTIONS-BG-color: rgba(49, 37, 37, 1); /* Background color of other sections */
|
||||
--MENU-SECTIONS-LINK-color: rgba(204, 204, 204, 1); /* Color of links in menu */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(230, 230, 230, 1); /* Color of links in menu, when hovered */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(119, 119, 119, 1); /* Color of active category text */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba(255, 255, 255, 1); /* Color of background for the active category (only) */
|
||||
|
||||
--MENU-VISITED-color: rgba(243, 28, 28, 1); /* Color of 'page visited' icons in menu */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(43, 32, 32, 1); /* Color of <hr> separator in menu */
|
||||
|
||||
/* base styling for boxes */
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* color of the title text */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* color of the content background */
|
||||
--BOX-TEXT-color: rgba(16, 16, 16, 1); /* fixed color of the content text */
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
:root {
|
||||
/* relearn-bright */
|
||||
--PRIMARY-color: rgba(131, 201, 50, 1); /* brand primary color */
|
||||
--SECONDARY-color: rgba(99, 128, 208, 1); /* brand secondary color */
|
||||
--ACCENT-color: rgb(255, 102, 78, 1); /* brand accent color, used for search highlights */
|
||||
|
||||
--MAIN-TEXT-color: rgba(0, 0, 0, 1); /* text color of content and h1 titles */
|
||||
--MAIN-LINK-HOVER-color: rgba(32, 40, 145, 1); /* hovered link color of content */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* background color of content */
|
||||
--MAIN-TITLES-TEXT-color: rgba(16, 16, 16, 1); /* text color of h2-h6 titles and transparent box titles */
|
||||
|
||||
--CODE-theme: relearn-light; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(39, 40, 34, 1); /* fallback text color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BG-color: rgba(250, 250, 250, 1); /* fallback background color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BORDER-color: rgba(216, 216, 216, 1); /* border color of block code */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* text color of inline code */
|
||||
--CODE-INLINE-BG-color: rgba(255, 250, 233, 1); /* background color of inline code */
|
||||
--CODE-INLINE-BORDER-color: rgba(248, 232, 200, 1); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HEADER-BG-color: rgba(0, 0, 0, 0); /* background color of menu header */
|
||||
--MENU-HEADER-SEPARATOR-color: rgba(96, 96, 96, 1); /* separator color between menu header and menu */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(64, 64, 64, 1); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(0, 0, 0, 1); /* hovered home button color if configured */
|
||||
|
||||
--MENU-SEARCH-color: rgba(64, 64, 64, 1); /* text and icon color of search box */
|
||||
--MENU-SEARCH-BG-color: rgba(255, 255, 255, 0.2); /* background color of search box */
|
||||
--MENU-SEARCH-BORDER-color: transparent; /* border color of search box */
|
||||
|
||||
--MENU-SECTIONS-BG-color: rgba(131, 201, 50, 1); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: transparent; /* background color of the active menu section */
|
||||
--MENU-SECTIONS-LINK-color: rgba(50, 50, 50, 1); /* link color of menu topics */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(255, 255, 255, 1); /* hovered link color of menu topics */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(50, 50, 50, 1); /* text color of the displayed menu topic */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(96, 96, 96, 1); /* separator color between menu sections and menu footer */
|
||||
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* text color of colored box titles */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* background color of colored boxes */
|
||||
--BOX-TEXT-color: rgba(16, 16, 16, 1); /* text color of colored box content */
|
||||
}
|
||||
46
themes/hugo-theme-relearn/assets/css/theme-relearn-dark.css
Normal file
46
themes/hugo-theme-relearn/assets/css/theme-relearn-dark.css
Normal file
@@ -0,0 +1,46 @@
|
||||
:root {
|
||||
/* relearn-dark */
|
||||
--PRIMARY-color: rgba(125, 201, 3, 1); /* brand primary color */
|
||||
--SECONDARY-color: rgba(108, 140, 227, 1); /* brand secondary color */
|
||||
--ACCENT-color: rgb(255, 102, 78, 1); /* brand accent color, used for search highlights */
|
||||
|
||||
--MAIN-TEXT-color: rgba(224, 224, 224, 1); /* text color of content and h1 titles */
|
||||
--MAIN-LINK-HOVER-color: rgba(147, 176, 255, 1); /* hovered link color of content */
|
||||
--MAIN-BG-color: rgba(32, 32, 32, 1); /* background color of content */
|
||||
--MAIN-TITLES-TEXT-color: rgba(255, 255, 255, 1); /* text color of h2-h6 titles and transparent box titles */
|
||||
|
||||
--CODE-theme: relearn-dark; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(248, 248, 242, 1); /* fallback text color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BG-color: rgba(43, 43, 43, 1); /* fallback background color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BORDER-color: rgba(71, 71, 71, 1); /* border color of block code */
|
||||
--CODE-INLINE-color: rgba(130, 229, 80, 1); /* text color of inline code */
|
||||
--CODE-INLINE-BG-color: rgba(45, 45, 45, 1); /* background color of inline code */
|
||||
--CODE-INLINE-BORDER-color: rgba(70, 70, 70, 1); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HEADER-color: rgba(40, 40, 40, 1); /* color of menu header */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(64, 64, 64, 1); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(0, 0, 0, 1); /* hovered home button color if configured */
|
||||
|
||||
--MENU-SEARCH-color: rgba(224, 224, 224, 1); /* text and icon color of search box */
|
||||
--MENU-SEARCH-BG-color: rgba(50, 50, 50, 1); /* background color of search box */
|
||||
--MENU-SEARCH-BORDER-color: rgba(224, 224, 224, 1); /* border color of search box */
|
||||
|
||||
--MENU-SECTIONS-BG-color: rgba(43, 43, 43, 1); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
|
||||
--MENU-SECTIONS-LINK-color: rgba(186, 186, 186, 1); /* link color of menu topics */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(255, 255, 255, 1); /* hovered link color of menu topics */
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(50, 50, 50, 1); /* background color of the active menu section */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(130, 229, 80, 1); /* text color of the displayed menu topic */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(96, 96, 96, 1); /* separator color between menu sections and menu footer */
|
||||
|
||||
--MENU-VISITED-color: rgba(72, 106, 201, 1); /* icon color of visited menu topics if configured */
|
||||
|
||||
--BOX-CAPTION-color: rgba(240, 240, 240, 1); /* text color of colored box titles */
|
||||
--BOX-BG-color: rgba(20, 20, 20, 1); /* background color of colored boxes */
|
||||
--BOX-TEXT-color: rgba(224, 224, 224, 1); /* text color of colored box content */
|
||||
}
|
||||
44
themes/hugo-theme-relearn/assets/css/theme-relearn-light.css
Normal file
44
themes/hugo-theme-relearn/assets/css/theme-relearn-light.css
Normal file
@@ -0,0 +1,44 @@
|
||||
:root {
|
||||
/* relearn-light */
|
||||
--PRIMARY-color: rgba(125, 201, 3, 1); /* brand primary color */
|
||||
--SECONDARY-color: rgba(72, 106, 201, 1); /* brand secondary color */
|
||||
--ACCENT-color: rgb(255, 102, 78); /* brand accent color, used for search highlights */
|
||||
|
||||
--MAIN-TEXT-color: rgba(0, 0, 0, 1); /* text color of content and h1 titles */
|
||||
--MAIN-LINK-HOVER-color: rgba(32, 40, 145, 1); /* hovered link color of content */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* background color of content */
|
||||
--MAIN-TITLES-TEXT-color: rgba(16, 16, 16, 1); /* text color of h2-h6 titles and transparent box titles */
|
||||
|
||||
--CODE-theme: relearn-light; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(39, 40, 34, 1); /* fallback text color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BG-color: rgba(250, 250, 250, 1); /* fallback background color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BORDER-color: rgba(216, 216, 216, 1); /* border color of block code */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* text color of inline code */
|
||||
--CODE-INLINE-BG-color: rgba(255, 250, 233, 1); /* background color of inline code */
|
||||
--CODE-INLINE-BORDER-color: rgba(248, 232, 200, 1); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-HEADER-color: rgba(40, 40, 40, 1); /* color of menu header */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(64, 64, 64, 1); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(0, 0, 0, 1); /* hovered home button color if configured */
|
||||
|
||||
--MENU-SEARCH-color: rgba(224, 224, 224, 1); /* text and icon color of search box */
|
||||
--MENU-SEARCH-BG-color: rgba(50, 50, 50, 1); /* background color of search box */
|
||||
--MENU-SEARCH-BORDER-color: rgba(224, 224, 224, 1); /* border color of search box */
|
||||
|
||||
--MENU-SECTIONS-BG-color: rgba(40, 40, 40, 1); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: rgba(0, 0, 0, 0.166); /* background color of the active menu section */
|
||||
--MENU-SECTIONS-LINK-color: rgba(186, 186, 186, 1); /* link color of menu topics */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(255, 255, 255, 1); /* hovered link color of menu topics */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(68, 68, 68, 1); /* text color of the displayed menu topic */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(96, 96, 96, 1); /* separator color between menu sections and menu footer */
|
||||
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* text color of colored box titles */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* background color of colored boxes */
|
||||
--BOX-TEXT-color: rgba(16, 16, 16, 1); /* text color of colored box content */
|
||||
}
|
||||
1
themes/hugo-theme-relearn/assets/css/theme-relearn.css
Normal file
1
themes/hugo-theme-relearn/assets/css/theme-relearn.css
Normal file
@@ -0,0 +1 @@
|
||||
@import 'theme-relearn-light.css';
|
||||
52
themes/hugo-theme-relearn/assets/css/theme-zen-dark.css
Normal file
52
themes/hugo-theme-relearn/assets/css/theme-zen-dark.css
Normal file
@@ -0,0 +1,52 @@
|
||||
:root {
|
||||
/* zen-dark */
|
||||
--PRIMARY-color: rgba(47, 129, 235, 1); /* brand primary color */
|
||||
--SECONDARY-color: rgba(47, 129, 235, 1); /* brand secondary color */
|
||||
|
||||
--MAIN-TOPBAR-BORDER-color: rgba(71, 71, 71, 1); /* border color between topbar and content */
|
||||
--MAIN-LINK-HOVER-color: rgb(112, 174, 245); /* hovered link color of content */
|
||||
--MAIN-BG-color: rgba(32, 32, 32, 1); /* background color of content */
|
||||
--MAIN-TEXT-color: rgba(224, 224, 224, 1); /* text color of content and h1 titles */
|
||||
--MAIN-TITLES-TEXT-color: rgba(255, 255, 255, 1); /* text color of h2-h6 titles and transparent box titles */
|
||||
|
||||
--CODE-theme: relearn-dark; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(248, 248, 242, 1); /* fallback text color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BG-color: rgba(43, 43, 43, 1); /* fallback background color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BORDER-color: rgba(71, 71, 71, 1); /* border color of block code */
|
||||
--CODE-INLINE-color: rgba(130, 229, 80, 1); /* text color of inline code */
|
||||
--CODE-INLINE-BG-color: rgba(45, 45, 45, 1); /* background color of inline code */
|
||||
--CODE-INLINE-BORDER-color: rgba(71, 71, 71, 1); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-BORDER-color: rgba(71, 71, 71, 1); /* border color between menu and content */
|
||||
--MENU-TOPBAR-BORDER-color: rgba(39, 39, 39, 1); /* separator color of vertical line between menu and topbar */
|
||||
--MENU-TOPBAR-SEPARATOR-color: rgba(71, 71, 71, 1); /* separator color of vertical line between menu and topbar */
|
||||
--MENU-HEADER-BG-color: transparent; /* background color of menu header */
|
||||
--MENU-HEADER-BORDER-color: transparent; /* border color between menu header and menu */
|
||||
--MENU-HEADER-SEPARATOR-color: rgba(71, 71, 71, 0.66); /* separator color between menu header and menu */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(240, 240, 240, 1); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(47, 129, 235, 1); /* hovered home button color if configured */
|
||||
|
||||
--MENU-SEARCH-color: rgba(47, 129, 235, 1); /* text and icon color of search box */
|
||||
--MENU-SEARCH-BG-color: rgba(32, 32, 32, 1); /* background color of search box */
|
||||
--MENU-SEARCH-BORDER-color: rgba(71, 71, 71, 0.66); /* border color of search box */
|
||||
|
||||
--MENU-SECTIONS-BG-color: rgba(39, 39, 39, 1); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: transparent; /* background color of the active menu section */
|
||||
--MENU-SECTIONS-LINK-color: rgba(240, 240, 240, 0.75); /* link color of menu topics */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(47, 129, 235, 1); /* hoverd link color of menu topics */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(47, 129, 235, 1); /* text color of the displayed menu topic */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba(32, 32, 32, 1); /* background color of the displayed menu topic */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(71, 71, 71, 0.66); /* separator color between menu sections and menu footer */
|
||||
|
||||
--BOX-CAPTION-color: rgba(240, 240, 240, 1); /* text color of colored box titles */
|
||||
--BOX-BG-color: rgba(20, 20, 20, 1); /* background color of colored boxes */
|
||||
--BOX-TEXT-color: rgba(240, 240, 240, 1); /* text color of colored box content */
|
||||
|
||||
--BOX-GREY-color: rgba(71, 71, 71, 1); /* background color of grey boxes */
|
||||
}
|
||||
52
themes/hugo-theme-relearn/assets/css/theme-zen-light.css
Normal file
52
themes/hugo-theme-relearn/assets/css/theme-zen-light.css
Normal file
@@ -0,0 +1,52 @@
|
||||
:root {
|
||||
/* zen-light */
|
||||
--PRIMARY-color: rgba(26, 115, 232, 1); /* brand primary color */
|
||||
--SECONDARY-color: rgba(26, 115, 232, 1); /* brand secondary color */
|
||||
|
||||
--MAIN-TOPBAR-BORDER-color: rgba(210, 210, 210, 1); /* border color between topbar and content */
|
||||
--MAIN-LINK-HOVER-color: rgba(32, 40, 145, 1); /* hoverd link color of content */
|
||||
--MAIN-BG-color: rgba(255, 255, 255, 1); /* background color of content */
|
||||
--MAIN-TEXT-color: rgba(0, 0, 0, 1); /* text color of content and h1 titles */
|
||||
--MAIN-TITLES-TEXT-color: rgba(16, 16, 16, 1); /* text color of h2-h6 titles and transparent box titles */
|
||||
|
||||
--CODE-theme: relearn-light; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba(39, 40, 34, 1); /* fallback text color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BG-color: rgba(250, 250, 250, 1); /* fallback background color of block code; should be adjusted to your selected chroma style */
|
||||
--CODE-BLOCK-BORDER-color: rgba(210, 210, 210, 1); /* border color of block code */
|
||||
--CODE-INLINE-color: rgba(94, 94, 94, 1); /* text color of inline code */
|
||||
--CODE-INLINE-BG-color: rgba(255, 250, 233, 1); /* background color of inline code */
|
||||
--CODE-INLINE-BORDER-color: rgba(248, 232, 200, 1); /* border color of inline code */
|
||||
|
||||
--BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */
|
||||
--MERMAID-theme: default; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */
|
||||
--OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */
|
||||
|
||||
--MENU-BORDER-color: rgba(210, 210, 210, 1); /* border color between menu and content */
|
||||
--MENU-TOPBAR-BORDER-color: rgba(247, 247, 247, 1); /* border color of vertical line between menu and topbar */
|
||||
--MENU-TOPBAR-SEPARATOR-color: rgba(210, 210, 210, 1); /* separator color of vertical line between menu and topbar */
|
||||
--MENU-HEADER-BG-color: transparent; /* background color of menu header */
|
||||
--MENU-HEADER-BORDER-color: transparent; /* border color between menu header and menu */
|
||||
--MENU-HEADER-SEPARATOR-color: rgba(210, 210, 210, 0.66); /* separator color between menu header and menu */
|
||||
|
||||
--MENU-HOME-LINK-color: rgba(48, 48, 48, 1); /* home button color if configured */
|
||||
--MENU-HOME-LINK-HOVER-color: rgba(26, 115, 232, 1); /* hoverd home button color if configured */
|
||||
|
||||
--MENU-SEARCH-color: rgba(26, 115, 232, 1); /* text and icon color of search box */
|
||||
--MENU-SEARCH-BG-color: rgba(255, 255, 255, 1); /* background color of search box */
|
||||
--MENU-SEARCH-BORDER-color: rgba(210, 210, 210, 0.66); /* border color of search box */
|
||||
|
||||
--MENU-SECTIONS-BG-color: rgba(134, 134, 134, 0.066); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */
|
||||
--MENU-SECTIONS-ACTIVE-BG-color: transparent; /* background color of the active menu section */
|
||||
--MENU-SECTIONS-LINK-color: rgba(48, 48, 48, 1); /* link color of menu topics */
|
||||
--MENU-SECTIONS-LINK-HOVER-color: rgba(26, 115, 232, 1); /* hoverd link color of menu topics */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-color: rgba(26, 115, 232, 1); /* text color of the displayed menu topic */
|
||||
--MENU-SECTION-ACTIVE-CATEGORY-BG-color: rgba(255, 255, 255, 1); /* background color of the displayed menu topic */
|
||||
--MENU-SECTION-SEPARATOR-color: rgba(210, 210, 210, 0.66); /* separator color between menu sections and menu footer */
|
||||
|
||||
--BOX-CAPTION-color: rgba(255, 255, 255, 1); /* text color of colored box titles */
|
||||
--BOX-BG-color: rgba(255, 255, 255, 0.833); /* background color of colored boxes */
|
||||
--BOX-TEXT-color: rgba(48, 48, 48, 1); /* text color of colored box content */
|
||||
|
||||
--BOX-GREY-color: rgba(210, 210, 210, 1); /* background color of grey boxes */
|
||||
}
|
||||
2873
themes/hugo-theme-relearn/assets/css/theme.css
Normal file
2873
themes/hugo-theme-relearn/assets/css/theme.css
Normal file
File diff suppressed because it is too large
Load Diff
157
themes/hugo-theme-relearn/assets/css/variables.css
Normal file
157
themes/hugo-theme-relearn/assets/css/variables.css
Normal file
@@ -0,0 +1,157 @@
|
||||
/* initially use section background to avoid flickering on load when a non default variant is active;
|
||||
this is only possible because every color variant defines this variable, otherwise we would have been lost */
|
||||
--INTERNAL-PRIMARY-color: var(--PRIMARY-color, var(--MENU-HEADER-BG-color, rgba( 0, 0, 0, 0 ))); /* not --INTERNAL-MENU-HEADER-BG-color */
|
||||
--INTERNAL-SECONDARY-color: var(--SECONDARY-color, var(--MAIN-LINK-color, rgba( 72, 106, 201, 1 ))); /* not --INTERNAL-MAIN-LINK-color */
|
||||
--INTERNAL-ACCENT-color: var(--ACCENT-color, rgba( 255, 255, 0, 1 ));
|
||||
|
||||
--INTERNAL-MAIN-TOPBAR-BORDER-color: var(--MAIN-TOPBAR-BORDER-color, transparent);
|
||||
--INTERNAL-MAIN-LINK-color: var(--MAIN-LINK-color, var(--SECONDARY-color, rgba( 72, 106, 201, 1 ))); /* not --INTERNAL-SECONDARY-color */
|
||||
--INTERNAL-MAIN-LINK-HOVER-color: var(--MAIN-LINK-HOVER-color, var(--INTERNAL-MAIN-LINK-color));
|
||||
--INTERNAL-MAIN-BG-color: var(--MAIN-BG-color, rgba( 255, 255, 255, 1 ));
|
||||
--INTERNAL-MAIN-BOLD-font-weight: var(--MAIN-BOLD-font-weight, 800);
|
||||
|
||||
--INTERNAL-MAIN-TEXT-color: var(--MAIN-TEXT-color, rgba( 16, 16, 16, 1 ));
|
||||
--INTERNAL-MAIN-font: var(--MAIN-font, "Roboto Flex", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif);
|
||||
--INTERNAL-MAIN-font-variation-settings: var(--MAIN-font-variation-settings, "wdth" 118, "GRAD" -200, "YTFI" 710);
|
||||
--INTERNAL-MAIN-font-weight: var(--MAIN-font-weight, 300);
|
||||
--INTERNAL-MAIN-letter-spacing: var(--MAIN-letter-spacing, .014em);
|
||||
|
||||
--INTERNAL-MAIN-TITLES-TEXT-color: var(--MAIN-TITLES-TEXT-color, var(--INTERNAL-MAIN-TEXT-color));
|
||||
--INTERNAL-MAIN-TITLES-font: var(--MAIN-TITLES-font, var(--MAIN-TITLES-TEXT-font, var(--INTERNAL-MAIN-font)));
|
||||
--INTERNAL-MAIN-TITLES-font-variation-settings: var(--MAIN-TITLES-font-variation-settings, "wdth" 118, "GRAD" 0, "YTFI" 710);
|
||||
--INTERNAL-MAIN-TITLES-font-weight: var(--MAIN-TITLES-font-weight, 500);
|
||||
--INTERNAL-MAIN-TITLES-letter-spacing: var(--MAIN-TITLES-letter-spacing, var(--INTERNAL-MAIN-letter-spacing));
|
||||
|
||||
--INTERNAL-MAIN-TITLES-H1-TEXT-color: var(--MAIN-TITLES-H1-TEXT-color, var(--MAIN-TITLES-H1-color, var(--INTERNAL-MAIN-TEXT-color)));
|
||||
--INTERNAL-MAIN-TITLES-H1-font: var(--MAIN-TITLES-H1-font, var(--INTERNAL-MAIN-font));
|
||||
--INTERNAL-MAIN-TITLES-H1-font-variation-settings: var(--MAIN-TITLES-H1-font-variation-settings, "wdth" 118, "GRAD" -100, "YTFI" 710);
|
||||
--INTERNAL-MAIN-TITLES-H1-font-weight: var(--MAIN-TITLES-H1-font-weight, 200);
|
||||
--INTERNAL-MAIN-TITLES-H1-letter-spacing: var(--MAIN-TITLES-H1-letter-spacing, var(--INTERNAL-MAIN-letter-spacing));
|
||||
|
||||
--INTERNAL-MAIN-TITLES-H2-TEXT-color: var(--MAIN-TITLES-H2-TEXT-color, var(--MAIN-TITLES-H2-color, var(--INTERNAL-MAIN-TITLES-TEXT-color)));
|
||||
--INTERNAL-MAIN-TITLES-H2-font: var(--MAIN-TITLES-H2-font, var(--INTERNAL-MAIN-TITLES-font));
|
||||
--INTERNAL-MAIN-TITLES-H2-font-variation-settings: var(--MAIN-TITLES-H2-font-variation-settings, var(--INTERNAL-MAIN-TITLES-font-variation-settings));
|
||||
--INTERNAL-MAIN-TITLES-H2-font-weight: var(--MAIN-TITLES-H2-font-weight, var(--INTERNAL-MAIN-TITLES-font-weight));
|
||||
--INTERNAL-MAIN-TITLES-H2-letter-spacing: var(--MAIN-TITLES-H2-letter-spacing, var(--INTERNAL-MAIN-TITLES-letter-spacing));
|
||||
|
||||
--INTERNAL-MAIN-TITLES-H3-TEXT-color: var(--MAIN-TITLES-H3-TEXT-color, var(--MAIN-TITLES-H3-color, var(--INTERNAL-MAIN-TITLES-H2-TEXT-color)));
|
||||
--INTERNAL-MAIN-TITLES-H3-font: var(--MAIN-TITLES-H3-font, var(--INTERNAL-MAIN-TITLES-H2-font));
|
||||
--INTERNAL-MAIN-TITLES-H3-font-variation-settings: var(--MAIN-TITLES-H3-font-variation-settings, var(--INTERNAL-MAIN-TITLES-H2-font-variation-settings));
|
||||
--INTERNAL-MAIN-TITLES-H3-font-weight: var(--MAIN-TITLES-H3-font-weight, var(--INTERNAL-MAIN-TITLES-H2-font-weight));
|
||||
--INTERNAL-MAIN-TITLES-H3-letter-spacing: var(--MAIN-TITLES-H3-letter-spacing, var(--INTERNAL-MAIN-TITLES-H2-letter-spacing));
|
||||
|
||||
--INTERNAL-MAIN-TITLES-H4-TEXT-color: var(--MAIN-TITLES-H4-TEXT-color, var(--MAIN-TITLES-H4-color, var(--INTERNAL-MAIN-TITLES-H3-TEXT-color)));
|
||||
--INTERNAL-MAIN-TITLES-H4-font: var(--MAIN-TITLES-H4-font, var(--INTERNAL-MAIN-TITLES-H3-font));
|
||||
--INTERNAL-MAIN-TITLES-H4-font-variation-settings: var(--MAIN-TITLES-H4-font-variation-settings, "wdth" 118, "GRAD" -150, "YTFI" 710);
|
||||
--INTERNAL-MAIN-TITLES-H4-font-weight: var(--MAIN-TITLES-H4-font-weight, 300);
|
||||
--INTERNAL-MAIN-TITLES-H4-letter-spacing: var(--MAIN-TITLES-H4-letter-spacing, var(--INTERNAL-MAIN-TITLES-H3-letter-spacing));
|
||||
|
||||
--INTERNAL-MAIN-TITLES-H5-TEXT-color: var(--MAIN-TITLES-H5-TEXT-color, var(--MAIN-TITLES-H5-color, var(--INTERNAL-MAIN-TITLES-H4-TEXT-color)));
|
||||
--INTERNAL-MAIN-TITLES-H5-font: var(--MAIN-TITLES-H5-font, var(--INTERNAL-MAIN-TITLES-H4-font));
|
||||
--INTERNAL-MAIN-TITLES-H5-font-variation-settings: var(--MAIN-TITLES-H5-font-variation-settings, var(--INTERNAL-MAIN-TITLES-H4-font-variation-settings));
|
||||
--INTERNAL-MAIN-TITLES-H5-font-weight: var(--MAIN-TITLES-H5-font-weight, var(--INTERNAL-MAIN-TITLES-H4-font-weight));
|
||||
--INTERNAL-MAIN-TITLES-H5-letter-spacing: var(--MAIN-TITLES-H5-letter-spacing, var(--INTERNAL-MAIN-TITLES-H4-letter-spacing));
|
||||
|
||||
--INTERNAL-MAIN-TITLES-H6-TEXT-color: var(--MAIN-TITLES-H6-TEXT-color, var(--MAIN-TITLES-H6-color, var(--INTERNAL-MAIN-TITLES-H5-TEXT-color)));
|
||||
--INTERNAL-MAIN-TITLES-H6-font: var(--MAIN-TITLES-H6-font, var(--INTERNAL-MAIN-TITLES-H5-font));
|
||||
--INTERNAL-MAIN-TITLES-H6-font-variation-settings: var(--MAIN-TITLES-H6-font-variation-settings, var(--INTERNAL-MAIN-TITLES-H5-font-variation-settings));
|
||||
--INTERNAL-MAIN-TITLES-H6-font-weight: var(--MAIN-TITLES-H6-font-weight, var(--INTERNAL-MAIN-TITLES-H5-font-weight));
|
||||
--INTERNAL-MAIN-TITLES-H6-letter-spacing: var(--MAIN-TITLES-H6-letter-spacing, var(--INTERNAL-MAIN-TITLES-H5-letter-spacing));
|
||||
|
||||
--INTERNAL-CODE-font: var(--CODE-font, "Consolas", menlo, monospace);
|
||||
--INTERNAL-CODE-font-variation-settings: var(--CODE-font-variation-settings, normal);
|
||||
--INTERNAL-CODE-font-weight: var(--CODE-font-weight, 300);
|
||||
--INTERNAL-CODE-letter-spacing: var(--CODE-letter-spacing, normal);
|
||||
|
||||
--INTERNAL-CODE-theme: var(--CODE-theme, relearn-light);
|
||||
--INTERNAL-CODE-BLOCK-color: var(--CODE-BLOCK-color, var(--MAIN-CODE-color, rgba( 39, 40, 34, 1 )));
|
||||
--INTERNAL-CODE-BLOCK-BG-color: var(--CODE-BLOCK-BG-color, var(--MAIN-CODE-BG-color, rgba( 250, 250, 250, 1 )));
|
||||
--INTERNAL-CODE-BLOCK-BORDER-color: var(--CODE-BLOCK-BORDER-color, var(--MAIN-CODE-BG-color, var(--INTERNAL-CODE-BLOCK-BG-color)));
|
||||
--INTERNAL-CODE-INLINE-color: var(--CODE-INLINE-color, rgba( 94, 94, 94, 1 ));
|
||||
--INTERNAL-CODE-INLINE-BG-color: var(--CODE-INLINE-BG-color, rgba( 255, 250, 233, 1 ));
|
||||
--INTERNAL-CODE-INLINE-BORDER-color: var(--CODE-INLINE-BORDER-color, rgba( 251, 240, 203, 1 ));
|
||||
|
||||
--INTERNAL-BROWSER-theme: var(--BROWSER-theme, light);
|
||||
--INTERNAL-MERMAID-theme: var(--CONFIG-MERMAID-theme, var(--MERMAID-theme, var(--INTERNAL-PRINT-MERMAID-theme)));
|
||||
--INTERNAL-OPENAPI-theme: var(--CONFIG-OPENAPI-theme, var(--OPENAPI-theme, var(--SWAGGER-theme, var(--INTERNAL-PRINT-OPENAPI-theme))));
|
||||
--INTERNAL-OPENAPI-CODE-theme: var(--CONFIG-OPENAPI-CODE-theme, var(--OPENAPI-CODE-theme, --INTERNAL-PRINT-OPENAPI-CODE-theme));
|
||||
|
||||
--INTERNAL-TAG-BG-color: var(--TAG-BG-color, var(--INTERNAL-PRIMARY-color));
|
||||
|
||||
--INTERNAL-MENU-BORDER-color: var(--MENU-BORDER-color, transparent);
|
||||
--INTERNAL-MENU-TOPBAR-BORDER-color: var(--MENU-TOPBAR-BORDER-color, var(--INTERNAL-MENU-HEADER-BG-color));
|
||||
--INTERNAL-MENU-TOPBAR-SEPARATOR-color: var(--MENU-TOPBAR-SEPARATOR-color, transparent);
|
||||
|
||||
--INTERNAL-MENU-HEADER-color: var(--MENU-HEADER-color, var(--INTERNAL-MENU-SECTIONS-LINK-color));
|
||||
--INTERNAL-MENU-HEADER-BG-color: var(--MENU-HEADER-BG-color, var(--PRIMARY-color, rgba( 0, 0, 0, 0 ))); /* not --INTERNAL-PRIMARY-color */
|
||||
--INTERNAL-MENU-HEADER-BORDER-color: var(--MENU-HEADER-BORDER-color, var(--INTERNAL-MENU-HEADER-BG-color));
|
||||
--INTERNAL-MENU-HEADER-SEPARATOR-color: var(--MENU-HEADER-SEPARATOR-color, var(--INTERNAL-MENU-HEADER-BORDER-color));
|
||||
|
||||
--INTERNAL-MENU-HOME-LINK-color: var(--MENU-HOME-LINK-color, rgba( 50, 50, 50, 1 ));
|
||||
--INTERNAL-MENU-HOME-LINK-HOVER-color: var(--MENU-HOME-LINK-HOVER-color, var(--MENU-HOME-LINK-HOVERED-color, rgba( 128, 128, 128, 1 )));
|
||||
|
||||
--INTERNAL-MENU-SEARCH-color: var(--MENU-SEARCH-color, var(--MENU-SEARCH-BOX-ICONS-color, rgba( 224, 224, 224, 1 )));
|
||||
--INTERNAL-MENU-SEARCH-BG-color: var(--MENU-SEARCH-BG-color, rgba( 50, 50, 50, 1 ));
|
||||
--INTERNAL-MENU-SEARCH-BORDER-color: var(--MENU-SEARCH-BORDER-color, var(--MENU-SEARCH-BOX-color, var(--INTERNAL-MENU-SEARCH-BG-color)));
|
||||
|
||||
--INTERNAL-MENU-SECTIONS-ACTIVE-BG-color: var(--MENU-SECTIONS-ACTIVE-BG-color, rgba( 0, 0, 0, .166 ));
|
||||
--INTERNAL-MENU-SECTIONS-BG-color: var(--MENU-SECTIONS-BG-color, rgba( 40, 40, 40, 1 ));
|
||||
--INTERNAL-MENU-SECTIONS-LINK-color: var(--MENU-SECTIONS-LINK-color, rgba( 186, 186, 186, 1 ));
|
||||
--INTERNAL-MENU-SECTIONS-LINK-HOVER-color: var(--MENU-SECTIONS-LINK-HOVER-color, var(--INTERNAL-MENU-SECTIONS-LINK-color));
|
||||
--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-color: var(--MENU-SECTION-ACTIVE-CATEGORY-color, rgba( 68, 68, 68, 1 ));
|
||||
--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-BG-color: var(--MENU-SECTION-ACTIVE-CATEGORY-BG-color, var(--INTERNAL-MAIN-BG-color));
|
||||
--INTERNAL-MENU-SECTION-ACTIVE-CATEGORY-BORDER-color: var(--MENU-SECTION-ACTIVE-CATEGORY-BORDER-color, transparent);
|
||||
|
||||
--INTERNAL-MENU-VISITED-color: var(--MENU-VISITED-color, var(--INTERNAL-SECONDARY-color));
|
||||
--INTERNAL-MENU-SECTION-SEPARATOR-color: var(--MENU-SECTION-SEPARATOR-color, var(--MENU-SECTION-HR-color, rgba( 96, 96, 96, 1 )));
|
||||
|
||||
--INTERNAL-BOX-CAPTION-color: var(--BOX-CAPTION-color, rgba( 255, 255, 255, 1 ));
|
||||
--INTERNAL-BOX-BG-color: var(--BOX-BG-color, rgba( 255, 255, 255, .833 ));
|
||||
--INTERNAL-BOX-TEXT-color: var(--BOX-TEXT-color, var(--INTERNAL-MAIN-TEXT-color));
|
||||
|
||||
--INTERNAL-BOX-BLUE-color: var(--BOX-BLUE-color, rgba( 48, 117, 229, 1 ));
|
||||
--INTERNAL-BOX-CYAN-color: var(--BOX-CYAN-color, rgba( 45, 190, 200, 1 ));
|
||||
--INTERNAL-BOX-GREEN-color: var(--BOX-GREEN-color, rgba( 42, 178, 24, 1 ));
|
||||
--INTERNAL-BOX-GREY-color: var(--BOX-GREY-color, rgba( 160, 160, 160, 1 ));
|
||||
--INTERNAL-BOX-MAGENTA-color: var(--BOX-MAGENTA-color, rgba( 229, 50, 210, 1 ));
|
||||
--INTERNAL-BOX-ORANGE-color: var(--BOX-ORANGE-color, rgba( 237, 153, 9, 1 ));
|
||||
--INTERNAL-BOX-RED-color: var(--BOX-RED-color, rgba( 224, 62, 62, 1 ));
|
||||
|
||||
--INTERNAL-BOX-CAUTION-color: var(--BOX-CAUTION-color, var(--INTERNAL-BOX-MAGENTA-color));
|
||||
--INTERNAL-BOX-INFO-color: var(--BOX-INFO-color, var(--INTERNAL-BOX-BLUE-color));
|
||||
--INTERNAL-BOX-IMPORTANT-color: var(--BOX-IMPORTANT-color, var(--INTERNAL-BOX-CYAN-color));
|
||||
--INTERNAL-BOX-NEUTRAL-color: var(--BOX-NEUTRAL-color, var(--INTERNAL-BOX-GREY-color));
|
||||
--INTERNAL-BOX-NOTE-color: var(--BOX-NOTE-color, var(--INTERNAL-BOX-ORANGE-color));
|
||||
--INTERNAL-BOX-TIP-color: var(--BOX-TIP-color, var(--INTERNAL-BOX-GREEN-color));
|
||||
--INTERNAL-BOX-WARNING-color: var(--BOX-WARNING-color, var(--INTERNAL-BOX-RED-color));
|
||||
|
||||
--INTERNAL-BOX-BLUE-TEXT-color: var(--BOX-BLUE-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
--INTERNAL-BOX-CYAN-TEXT-color: var(--BOX-CYAN-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
--INTERNAL-BOX-GREEN-TEXT-color: var(--BOX-GREEN-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
--INTERNAL-BOX-GREY-TEXT-color: var(--BOX-GREY-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
--INTERNAL-BOX-MAGENTA-TEXT-color: var(--BOX-MAGENTA-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
--INTERNAL-BOX-ORANGE-TEXT-color: var(--BOX-ORANGE-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
--INTERNAL-BOX-RED-TEXT-color: var(--BOX-RED-TEXT-color, var(--INTERNAL-BOX-TEXT-color));
|
||||
|
||||
--INTERNAL-BOX-CAUTION-TEXT-color: var(--BOX-CAUTION-TEXT-color, var(--INTERNAL-BOX-MAGENTA-TEXT-color));
|
||||
--INTERNAL-BOX-INFO-TEXT-color: var(--BOX-INFO-TEXT-color, var(--INTERNAL-BOX-BLUE-TEXT-color));
|
||||
--INTERNAL-BOX-IMPORTANT-TEXT-color: var(--BOX-IMPORTANT-TEXT-color, var(--INTERNAL-BOX-CYAN-TEXT-color));
|
||||
--INTERNAL-BOX-NEUTRAL-TEXT-color: var(--BOX-NEUTRAL-TEXT-color, var(--INTERNAL-BOX-GREY-TEXT-color));
|
||||
--INTERNAL-BOX-NOTE-TEXT-color: var(--BOX-NOTE-TEXT-color, var(--INTERNAL-BOX-ORANGE-TEXT-color));
|
||||
--INTERNAL-BOX-TIP-TEXT-color: var(--BOX-TIP-TEXT-color, var(--INTERNAL-BOX-GREEN-TEXT-color));
|
||||
--INTERNAL-BOX-WARNING-TEXT-color: var(--BOX-WARNING-TEXT-color, var(--INTERNAL-BOX-RED-TEXT-color));
|
||||
|
||||
/* print style, values taken from relearn-light as it is used as a default print style */
|
||||
--INTERNAL-PRINT-MAIN-BG-color: var(--PRINT-MAIN-BG-color, rgba( 255, 255, 255, 1 ));
|
||||
--INTERNAL-PRINT-CODE-font: var(--PRINT-CODE-font, "Consolas", menlo, monospace);
|
||||
--INTERNAL-PRINT-TAG-BG-color: var(--PRINT-TAG-BG-color, rgba( 125, 201, 3, 1 ));
|
||||
--INTERNAL-PRINT-MAIN-font: var(--PRINT-MAIN-font, "Roboto Flex", "Helvetica", "Tahoma", "Geneva", "Arial", sans-serif);
|
||||
--INTERNAL-PRINT-MAIN-TEXT-color: var(--PRINT-MAIN-TEXT-color, rgba( 16, 16, 16, 1 ));
|
||||
--INTERNAL-PRINT-MERMAID-theme: var(--PRINT-MERMAID-theme, default);
|
||||
--INTERNAL-PRINT-OPENAPI-theme: var(--PRINT-OPENAPI-theme, var(--PRINT-SWAGGER-theme, light));
|
||||
--INTERNAL-PRINT-OPENAPI-CODE-theme: var(--PRINT-OPENAPI-CODE-theme, idea);
|
||||
|
||||
--INTERNAL-MENU-WIDTH-S: var(--MENU-WIDTH-S, 14.375rem);
|
||||
--INTERNAL-MENU-WIDTH-M: var(--MENU-WIDTH-M, 14.375rem);
|
||||
--INTERNAL-MENU-WIDTH-L: var(--MENU-WIDTH-L, 18.75rem);
|
||||
--INTERNAL-MAIN-WIDTH-MAX: var(--MAIN-WIDTH-MAX, 81.25rem);
|
||||
6
themes/hugo-theme-relearn/content/_relearn/_index.md
Normal file
6
themes/hugo-theme-relearn/content/_relearn/_index.md
Normal file
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
[_build]
|
||||
render = "never"
|
||||
list = "never"
|
||||
publishResources = false
|
||||
+++
|
||||
@@ -0,0 +1,18 @@
|
||||
{{- if and (not .Site.Params.disableSearchIndex) (not .Site.Params.disableSearchPage) }}
|
||||
{{- .EnableAllLanguages }}
|
||||
{{- $url := trim (or .Site.Params.searchPageURL "search") "/" }}
|
||||
{{- $content := dict
|
||||
"mediaType" "text/markdown"
|
||||
"value" ""
|
||||
}}
|
||||
{{- $page := dict
|
||||
"content" $content
|
||||
"kind" "page"
|
||||
"outputs" (slice "html")
|
||||
"path" "_relearn_searchpage"
|
||||
"title" (T "Search")
|
||||
"type" "_relearn_searchform"
|
||||
"url" $url
|
||||
}}
|
||||
{{- .AddPage $page }}
|
||||
{{- end }}
|
||||
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
[_build]
|
||||
render = "never"
|
||||
list = "never"
|
||||
publishResources = false
|
||||
+++
|
||||
@@ -0,0 +1 @@
|
||||
{}
|
||||
@@ -0,0 +1 @@
|
||||
{}
|
||||
19
themes/hugo-theme-relearn/docs/assets/images/logo.svg
Normal file
19
themes/hugo-theme-relearn/docs/assets/images/logo.svg
Normal file
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044">
|
||||
<style>
|
||||
@media (prefers-color-scheme: dark) {
|
||||
path { fill: white; }
|
||||
}
|
||||
</style>
|
||||
<path
|
||||
d="M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212 0 0 1-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255.809.239 1.706.724 2.068 1.843.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12 0 0 1-.499 1.309 1.757 1.757 0 0 1-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273 0 0 1-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711 0 0 0-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335"
|
||||
transform="translate(-40.698 -95.175)" />
|
||||
<path
|
||||
d="M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002 0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447 0 0 0 .303-.437.175.175 0 0 0 .013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547 0 0 0 .353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z"
|
||||
transform="translate(-40.698 -95.175)" />
|
||||
<path
|
||||
d="M83.128 98.116c-.484 1.875-1.057 3.757-2.486 5.033-.638.57-1.13.666-1.483.548-.401-.134-.715-.506-1.058-.973-.338-.461-.655-.97-1.076-1.332-.192-.165-.404-.315-.683-.38-.279-.066-.599-.02-.9.102-.489.196-.89.58-1.28 1.047a6.1 6.1 0 0 0-.985 1.632c-.234.591-.356 1.174-.277 1.713.072.487.392.977.905 1.185.463.187.926.156 1.36.154.433 0 .843.01 1.242.147.55.189.79.736.822 1.368.034.66-.145 1.412-.393 1.988l-.008.021c-.74 1.705-1.946 2.893-3.004 4.349l-.664.915.979.099c.924.092 1.788.26 2.468.675.46.281 1.806 1.205 2.794 2.222.497.513.888 1.031 1.047 1.502.078.231.095.422.05.6a.93.93 0 0 1-.345.474c-.301.223-.606.395-.864.532l-.354.186c-.107.058-.189.087-.345.228a.637.637 0 0 1 .062-.045l-.064.041-.209.236-.103.343s.003.126.007.152c.003.017.003.007.004.015v.002c.016.195.061.307.133.476a4.1 4.1 0 0 0 .32.596 5.7 5.7 0 0 0 2.8 2.258c.284.108.908.321 1.548.36.33.02.59.015.912-.13h.002c.08-.037.228-.095.382-.281.153-.186.19-.355.212-.445l.019-.075.003-.078c.023-.585-.037-1.296.072-1.899.153-.657.435-.956 1.009-.909 2.771.239 4.74 1.955 6.693 3.83l.742.714.279-1.155c.55-2.29 1.093-4.464 2.928-5.977.692-.57 1.184-.642 1.527-.509.39.151.676.536.996.995.319.458.605.926 1.07 1.212.194.119.464.232.784.209.32-.024.638-.163.988-.384 1.022-.645 1.778-1.756 2.086-2.942.136-.522.102-.991-.046-1.301-.158-.334-.433-.553-.754-.707-.653-.314-1.468-.373-2.094-.486-.825-.15-1.22-.475-1.345-.878-.13-.417 0-.953.335-1.61.6-1.173 1.887-2.602 3.13-3.911l.498-.526-.449-.432c-1.545-1.49-3.163-3.01-5.252-3.715h-.002c-.473-.16-1.097-.413-1.73-.424h-.003c-.311-.004-.596.04-.883.24v.002c-.22.155-.483.537-.583.937l-.008.036-.006.038c-.116.773-.06 1.467-.217 1.995-.063.212-.198.418-.359.507-.202.111-.492.153-.976.072-.582-.097-1.978-.69-3.021-1.503-.523-.407-.934-.85-1.117-1.3a1.153 1.153 0 0 1-.083-.63c.03-.184.1-.477.308-.593.21-.116.941-.32 1.377-.642h.002c.192-.141.403-.367.518-.64.114-.275.127-.526.123-.774-.006-.142-.036-.192-.08-.3a8.417 8.417 0 0 0-3-3.027c-1.226-.725-2.585-1.135-3.927-1.539-.434-.12-.844-.111-1.02.466zm.912.947c1.186.364 2.357.718 3.345 1.303 1.035.612 1.864 1.488 2.507 2.528-.514.263-1.095.5-1.44.79-.345.29-.729.914-.815 1.434-.084.509 0 .968.155 1.347.301.74.85 1.276 1.44 1.735 1.18.92 2.554 1.545 3.47 1.698.604.1 1.186.088 1.739-.216.594-.327.935-.911 1.088-1.427.264-.884.193-1.664.262-2.17h.1c.3.006.926.206 1.417.371 1.646.554 3.044 1.773 4.431 3.089-1.102 1.174-2.222 2.423-2.888 3.73-.42.823-.73 1.789-.453 2.687.283.913 1.1 1.415 2.138 1.603.691.126 1.472.226 1.84.403.19.091.258.182.278.223.03.064.058.075-.023.387-.21.804-.761 1.598-1.413 2.01-.247.155-.365.183-.407.187-.042.003-.061.002-.172-.066-.144-.088-.455-.473-.772-.929-.317-.454-.714-1.07-1.452-1.356-.783-.304-1.776-.022-2.713.75-1.942 1.6-2.626 3.764-3.146 5.8-1.802-1.676-3.772-3.138-6.589-3.517h-.002c-.346-.095-1.013-.031-1.293.143-.735.501-1.005 1.132-1.168 2.007-.125.69-.082 1.216-.074 1.659-.055.006-.046.01-.104.006-.42-.026-1.035-.215-1.244-.295-.947-.361-1.774-1.006-2.314-1.857-.054-.085-.072-.132-.109-.2l.027-.016c.284-.15.656-.36 1.045-.648.44-.327.789-.798.93-1.35a2.4 2.4 0 0 0-.068-1.379c-.254-.751-.753-1.353-1.295-1.911-1.09-1.124-2.452-2.049-2.99-2.378-.609-.372-1.303-.44-1.981-.56.875-1.094 1.878-2.251 2.596-3.921.294-.823.543-1.907.513-2.658-.049-.97-.489-2.013-1.52-2.367-.579-.2-1.131-.204-1.58-.203-.45.002-.786-.006-.97-.08h-.002c-.264-.107-.236-.108-.268-.33-.025-.17.021-.553.183-.962a4.67 4.67 0 0 1 .725-1.192c.29-.348.617-.59.705-.626.142-.057.176-.05.22-.04.045.011.127.052.263.17.235.201.56.671.92 1.161.354.484.791 1.08 1.543 1.33.8.267 1.784-.052 2.671-.846 1.594-1.424 2.235-3.317 2.714-5.051zm11.705 7.023c-.02.014.042-.002.042 0l-.008.035c.05-.2-.028-.04-.034-.035zM79.472 122.45a.198.198 0 0 1 .005.023v.014c-.002-.01-.003-.03-.005-.037zm-.29.732-.006.01-.044.027c.016-.01.033-.024.05-.036z"
|
||||
transform="translate(-40.698 -95.175)" />
|
||||
<path
|
||||
d="M76.694 128.845c-.85-.012-1.668.253-2.434.67-.01.592-.015 1.17.109 1.772.323 1.573.422 3.553-.07 5.147-.247.804-.684 1.535-1.347 1.891-.663.356-1.467.296-2.362-.159-.522-.266-1.059-.62-1.487-.757-.223-.072-.392-.096-.522-.069-.13.027-.232.094-.362.27-.53.719-.681 1.823-.497 2.876.177 1.012.418 1.438.543 1.56.143.137.26.154.604.055.548-.158 1.523-.857 2.573-.972l.02-.002.5.058c.686.081 1.247.562 1.622 1.19.372.62.591 1.37.73 2.136.279 1.532.25 3.16.083 4.232-.14.91-.394 1.72-.632 2.53 1.719-.385 3.485-.692 5.307-.36 1.174.214 2.749.574 3.762 1.977l.088.122.046.159c.162.551.16 1.114.024 1.578-.13.45-.348.772-.533 1.023-.181.246-.336.444-.437.606-.102.16-.141.275-.145.336-.01.17 0 .197.07.315.057.1.186.242.39.366.408.246 1.106.414 1.843.45a7.842 7.842 0 0 0 2.174-.21 4.28 4.28 0 0 0 .822-.296c.218-.106.385-.242.377-.233l.029-.031c.025-.035.05-.072.05-.068 0-.004 0-.017-.003-.05a2.733 2.733 0 0 0-.21-.579c-.26-.548-.839-1.333-.822-2.46.01-.657.27-1.21.598-1.576.32-.357.696-.575 1.074-.736.759-.323 1.57-.418 2.054-.458 1.653-.136 3.252.296 4.755.765.457.142.905.29 1.352.434.325-2.258.902-4.247.598-6.217-.071-.46-.25-1.169-.486-1.684-.238-.518-.495-.762-.675-.779-.351-.032-.716.14-1.174.418-.457.277-1.005.665-1.695.742-.745.082-1.406-.291-1.84-.908-.428-.608-.653-1.394-.754-2.196-.203-1.596.016-3.377.794-4.493.568-.813 1.358-.984 2.024-.835.65.146 1.243.51 1.769.779.524.267.99.413 1.237.365a.527.527 0 0 0 .346-.2c.11-.132.235-.373.37-.798.612-1.918.27-3.894-.246-6.054-2.815-.851-5.49-1.534-8.089-.267a.727.727 0 0 0-.223.148c-.024.028-.018.021-.026.056.001-.003-.01.178.07.44.162.522.611 1.29.911 1.978l.004.009.029.063.024.084V133c.162.635.016 1.297-.274 1.727-.272.404-.618.636-.952.81-.675.353-1.399.484-1.724.533a5.888 5.888 0 0 1-3.973-.795c-.512-.311-.876-.594-1.133-1.02-.282-.466-.318-1.084-.172-1.557.252-.814.715-1.266.971-1.89a.663.663 0 0 0 .047-.14c.001-.013 0-.006-.007-.037a.761.761 0 0 0-.184-.268c-.264-.267-.865-.595-1.54-.826-1.356-.462-3.07-.659-3.583-.686-.062-.002-.121-.006-.178-.006z"
|
||||
transform="translate(-40.698 -95.175)" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 9.6 KiB |
BIN
themes/hugo-theme-relearn/docs/assets/images/magic.gif
Normal file
BIN
themes/hugo-theme-relearn/docs/assets/images/magic.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.4 MiB |
65
themes/hugo-theme-relearn/docs/config/_default/hugo.toml
Normal file
65
themes/hugo-theme-relearn/docs/config/_default/hugo.toml
Normal file
@@ -0,0 +1,65 @@
|
||||
# this is a required setting for this theme to appear on https://themes.gohugo.io/
|
||||
# change this to a value appropriate for you; if your site is served from a subdirectory
|
||||
# set it like 'https://example.com/mysite/'
|
||||
baseURL = 'https://example.com/'
|
||||
|
||||
# required to be set to `true` to serve this page from a webserver AND the file system;
|
||||
# if you set this value to `true`, `baseURL` must not contain a subdirectory;
|
||||
# if you don't want to serve your page from the file system, you can also set this value
|
||||
# to `false`
|
||||
relativeURLs = true # true -> rewrite all site-relative URLs (those with a leading slash) to be relative to the current content
|
||||
|
||||
# if you set uglyURLs to `false`, this theme will append 'index.html' to any page bundle link
|
||||
# so your site can be also served from the file system; if you don't want that,
|
||||
# set `disableExplicitIndexURLs=true` in the [params] section,
|
||||
# if st to `true`, adjusting the link is not necessary, so `disableExplicitIndexURLs` has
|
||||
# no effect
|
||||
uglyURLs = false # true -> basic/index.html -> basic.html
|
||||
|
||||
# the directory where Hugo reads the themes from; this is specific to your
|
||||
# installation and most certainly needs be deleted or changed
|
||||
themesdir = '../..'
|
||||
# yeah, well, obviously a mandatory setting for your site, if you want to
|
||||
# use this theme ;-)
|
||||
theme = 'hugo-theme-relearn'
|
||||
|
||||
# make sure your defaultContentLanguage is the first one in the [languages]
|
||||
# array below, as the theme needs to make assumptions on it
|
||||
defaultContentLanguage = 'en'
|
||||
# if you want to get rrrid o' ourrr pirrrates nonsense uncomment th' next line
|
||||
# disableLanguages = ['pir']
|
||||
|
||||
# don't use any auto-generated summaries
|
||||
summaryLength = 10
|
||||
|
||||
# add showcase-specific output formats
|
||||
[outputs]
|
||||
# `print` - activate the themes feature to print whole chapters or leaf pages
|
||||
home = ['html', 'rss', 'print']
|
||||
section = ['html', 'rss', 'print']
|
||||
page = ['html', 'rss', 'print']
|
||||
|
||||
# add two showcase specific taxonomies for the parameter documentation;
|
||||
# the standard taxonomies must be repeated if they should be available
|
||||
# in such a case
|
||||
[taxonomies]
|
||||
category = 'categories'
|
||||
tag = 'tags'
|
||||
frontmatter = 'frontmatter'
|
||||
option = 'options'
|
||||
|
||||
# Showcase-specific non-standard theme parameter that should be not
|
||||
# contained in the defauzlt params.toml; delete it!
|
||||
[params]
|
||||
# Demo setting for displaying the siteparam shortcode the docs.
|
||||
siteparam.test.text = 'A **nested** option <b>with</b> formatting'
|
||||
# Extension to the image effects only for the docs.
|
||||
imageEffects.bg-white = true
|
||||
# This is for support of the variantgenerator in the docs, you don't need this!
|
||||
variantgenerator.force = true
|
||||
|
||||
[params.relearn]
|
||||
[params.relearn.dependencies]
|
||||
# This is for support of the variantgenerator in the docs, you don't need this!
|
||||
[params.relearn.dependencies.variantgenerator]
|
||||
name = 'VariantGenerator'
|
||||
181
themes/hugo-theme-relearn/docs/config/_default/languages.toml
Normal file
181
themes/hugo-theme-relearn/docs/config/_default/languages.toml
Normal file
@@ -0,0 +1,181 @@
|
||||
# showcase of the menu shortcuts; you can use relative URLs linking
|
||||
# to your content or use fully-qualified URLs to link outside of
|
||||
# your project
|
||||
[en]
|
||||
title = 'Hugo Relearn Theme'
|
||||
weight = 1
|
||||
languageCode = 'en'
|
||||
languageName = 'English'
|
||||
# Language dependent settings:
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
#contentDir = 'content/en'
|
||||
[en.params]
|
||||
landingPageName = '<i class="fa-fw fas fa-home"></i> Home'
|
||||
errorignore = ['exampleSite', 'images/hero.zip']
|
||||
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-anchor"></i> '
|
||||
name = 'Example Site'
|
||||
url = 'exampleSite/about/index.html'
|
||||
weight = 1
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fab fa-github"></i> '
|
||||
name = 'GitHub Repo'
|
||||
url = 'https://github.com/McShelby/hugo-theme-relearn'
|
||||
weight = 10
|
||||
[[en.menu.shortcuts]]
|
||||
name = 'Showcases'
|
||||
pageRef = '/showcase'
|
||||
weight = 20
|
||||
[[en.menu.shortcuts]]
|
||||
name = 'Credits'
|
||||
pageRef = '/more/credits'
|
||||
weight = 30
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-tags"></i> '
|
||||
name = 'Tags'
|
||||
pageRef = '/tags'
|
||||
weight = 40
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-layer-group"></i> '
|
||||
name = 'Categories'
|
||||
pageRef = '/categories'
|
||||
weight = 50
|
||||
|
||||
[[en.menu.devshortcuts]]
|
||||
identifier = 'devshortcuts'
|
||||
name = 'Dev Shortcuts'
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fab fa-hackerrank"></i> '
|
||||
name = 'Hugo'
|
||||
url = 'https://gohugo.io/documentation/'
|
||||
weight = 1
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fas fa-puzzle-piece"></i> '
|
||||
identifier = 'theme'
|
||||
name = 'Theme'
|
||||
weight = 2
|
||||
[[en.menu.devshortcuts.params]]
|
||||
alwaysopen = true
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-gears"></i> '
|
||||
identifier = 'configoptions'
|
||||
pageRef = 'configuration/reference'
|
||||
weight = 1
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fab fa-markdown"></i> '
|
||||
identifier = 'frontmatter'
|
||||
title = 'Front Matter Reference'
|
||||
pageRef = 'authoring/frontmatter/reference#annotated-front-matter'
|
||||
weight = 2
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-image"></i> '
|
||||
identifier = 'screenshotframe'
|
||||
title = 'Screenshot Frame'
|
||||
pageRef = 'images/hero.zip'
|
||||
weight = 3
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-wand-magic-sparkles"></i> '
|
||||
title = 'Maaagic Download'
|
||||
pageRef = 'images/magic.gif?download'
|
||||
weight = 4
|
||||
|
||||
# this is ourrr way t' showcase th' multilang settings by
|
||||
# doing autotrrranlat'n of th' english content; we are
|
||||
# lazy and don't supporrt furrrther trrranslations; arrr,
|
||||
# don't take it t' serrrious, fello'; it's prrretty hacky and:
|
||||
# NOT MEANT FER PRRRODUCTION! ARRR!
|
||||
|
||||
[pir]
|
||||
title = "Cap'n Hugo Relearrrn Theme"
|
||||
weight = 2
|
||||
# It would be more standard compliant to have the language key also
|
||||
# named art-x-pir but that would require to rename all files
|
||||
languageCode = 'art-x-pir'
|
||||
languageDirection = 'rtl' # you can explicitly override the reading direction here, otherwise the translation file contains a default
|
||||
languageName = 'Arrr! ☠ Pirrratish ☠'
|
||||
# Language dependent settings:
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
#contentDir = 'content/pir'
|
||||
[pir.params]
|
||||
landingPageName = '<i class="fa-fw fas home"></i> Arrr! Home'
|
||||
errorignore = ['exampleSite', 'images/hero.zip', '.*']
|
||||
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-anchor"></i> '
|
||||
name = 'Example Site'
|
||||
url = '../exampleSite/pir/about/index.html'
|
||||
weight = 1
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fab fa-github"></i> '
|
||||
name = 'GitHub Repo'
|
||||
url = 'https://github.com/McShelby/hugo-theme-relearn'
|
||||
weight = 10
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-camera"></i> '
|
||||
name = 'Showcases'
|
||||
pageRef = '/showcase'
|
||||
weight = 20
|
||||
[[pir.menu.shortcuts]]
|
||||
name = 'Crrredits'
|
||||
pageRef = '/more/credits'
|
||||
weight = 30
|
||||
[[pir.menu.shortcuts]]
|
||||
name = 'Arrr! Tags'
|
||||
pageRef = '/tags'
|
||||
weight = 40
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-layer-group"></i> '
|
||||
name = 'Categorrries'
|
||||
pageRef = '/categories'
|
||||
weight = 50
|
||||
|
||||
[[pir.menu.devshortcuts]]
|
||||
identifier = 'devshortcuts'
|
||||
name = 'Dev Shortcuts'
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fab fa-hackerrank"></i> '
|
||||
name = "Cap'n Hugo"
|
||||
url = 'https://gohugo.io/documentation/'
|
||||
weight = 1
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fas fa-puzzle-piece"></i> '
|
||||
identifier = 'theme'
|
||||
name = "Th' Theme"
|
||||
weight = 2
|
||||
[[pir.menu.devshortcuts.params]]
|
||||
alwaysopen = true
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-gears"></i> '
|
||||
identifier = 'configoptions'
|
||||
pageRef = 'configuration/reference'
|
||||
weight = 1
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fab fa-markdown"></i> '
|
||||
identifier = 'frontmatter'
|
||||
title = 'Front Matter Reference'
|
||||
pageRef = 'authoring/frontmatter/reference#annotated-front-matter'
|
||||
weight = 2
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-image"></i> '
|
||||
identifier = 'screenshotframe'
|
||||
title = 'Screenshot Frame'
|
||||
pageRef = 'images/hero.zip'
|
||||
weight = 3
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-wand-magic-sparkles"></i> '
|
||||
title = 'Maaagic Download'
|
||||
pageRef = 'images/magic.gif?download'
|
||||
weight = 4
|
||||
50
themes/hugo-theme-relearn/docs/config/_default/markup.toml
Normal file
50
themes/hugo-theme-relearn/docs/config/_default/markup.toml
Normal file
@@ -0,0 +1,50 @@
|
||||
[highlight]
|
||||
# line numbers in a table layout will shift if code is wrapping, so better
|
||||
# not use it; visually both layouts have the same look and behavior
|
||||
lineNumbersInTable = false
|
||||
|
||||
# the shipped variants come with their own modified chroma syntax highlighting
|
||||
# stylesheets which are linked in your generated HTML pages; you can use Hugo to generate
|
||||
# own stylesheets to your liking and use them in your variant;
|
||||
# if you want to use Hugo's internal styles instead of the shipped stylesheets:
|
||||
# - remove `noClasses` or set `noClasses = true`
|
||||
# - set `style` to a predefined style name
|
||||
# note: with using the internal styles, the `--CODE-theme` setting in your variant
|
||||
# stylesheet will be ignored and the internal style is used for all variants and
|
||||
# even print
|
||||
noClasses = false
|
||||
# style = 'tango'
|
||||
|
||||
[goldmark]
|
||||
# this is required for the themes docs to make the piratify shortcode work
|
||||
duplicateResourceFiles = true
|
||||
|
||||
# activated for this showcase to use HTML and JavaScript; decide on your own needs;
|
||||
# if in doubt, remove this line
|
||||
renderer.unsafe = true
|
||||
|
||||
[goldmark.extensions]
|
||||
strikethrough = false
|
||||
|
||||
# use Markdown extensions for this showcase
|
||||
[goldmark.extensions.extras]
|
||||
[goldmark.extensions.extras.delete]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.insert]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.mark]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.subscript]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.superscript]
|
||||
enable = true
|
||||
|
||||
[goldmark.extensions.passthrough]
|
||||
enable = true
|
||||
[goldmark.extensions.passthrough.delimiters]
|
||||
# the settings chosen here match the default initialization
|
||||
# of the MathJax library chosen by the theme;
|
||||
# if you want to adjust to different values you also need
|
||||
# to set them in `[params] mathJaxInitialize`
|
||||
inline = [['\(', '\)'], ['$', '$']]
|
||||
block = [['\[', '\]'], ['$$', '$$']]
|
||||
50
themes/hugo-theme-relearn/docs/config/_default/module.toml
Normal file
50
themes/hugo-theme-relearn/docs/config/_default/module.toml
Normal file
@@ -0,0 +1,50 @@
|
||||
# mounts are only needed in this showcase to access the publicly available screenshots and CHANGELOG;
|
||||
# remove this section if you don't need further mounts
|
||||
[[mounts]]
|
||||
source = 'archetypes'
|
||||
target = 'archetypes'
|
||||
[[mounts]]
|
||||
source = 'assets'
|
||||
target = 'assets'
|
||||
# Language dependent settings:
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-filename
|
||||
[[mounts]]
|
||||
source = 'content'
|
||||
target = 'content'
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
#[[mounts]]
|
||||
# lang = 'en'
|
||||
# source = 'content/en'
|
||||
# target = 'content'
|
||||
#[[mounts]]
|
||||
# lang = 'pir'
|
||||
# source = 'content/pir'
|
||||
# target = 'content'
|
||||
[[mounts]]
|
||||
source = 'data'
|
||||
target = 'data'
|
||||
[[mounts]]
|
||||
source = 'i18n'
|
||||
target = 'i18n'
|
||||
[[mounts]]
|
||||
source = 'layouts'
|
||||
target = 'layouts'
|
||||
[[mounts]]
|
||||
source = 'static'
|
||||
target = 'static'
|
||||
# just for this documentation to expose our config in the docs
|
||||
[[mounts]]
|
||||
source = 'config'
|
||||
target = 'assets/config'
|
||||
# just for this documentation to expose the GitHub hero image in the docs
|
||||
[[mounts]]
|
||||
source = '../images'
|
||||
target = 'assets/images'
|
||||
# just for this documentation to expose the CHANGELOG.md in the docs
|
||||
[[mounts]]
|
||||
source = '../CHANGELOG.md'
|
||||
target = 'assets/CHANGELOG.md'
|
||||
# just for this documentation to expose the README.md in the docs
|
||||
[[mounts]]
|
||||
source = '../README.md'
|
||||
target = 'assets/README.md'
|
||||
625
themes/hugo-theme-relearn/docs/config/_default/params.toml
Normal file
625
themes/hugo-theme-relearn/docs/config/_default/params.toml
Normal file
@@ -0,0 +1,625 @@
|
||||
# Theme-specific options;
|
||||
# For a detailed explanation and many more options see
|
||||
# https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html#annotated-configuration-options
|
||||
|
||||
# If an option value is said to be not set, you can achieve the same behavior
|
||||
# by giving it an empty string value.
|
||||
|
||||
###############################################################################
|
||||
# Hugo
|
||||
# These options usually apply to other themes as well.
|
||||
|
||||
# The title to be used for links to the main page
|
||||
# Default: not set
|
||||
# This name will be used for the link to the main page in the upper section
|
||||
# of the menu. If not set, `title` from the Hugo settings will be used.
|
||||
linkTitle = 'Relearn'
|
||||
|
||||
# The author of your site.
|
||||
# Default: not set
|
||||
# This will be used in HTML meta tags, the opengraph protocol and twitter
|
||||
# cards.
|
||||
# You can also set `author.email` if you want to publish this information.
|
||||
author.name = 'Sören Weber'
|
||||
|
||||
# The social media image of your site.
|
||||
# Default: not set
|
||||
# This is used for generating social media meta information for the opengraph
|
||||
# protocol and twitter cards.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
images = [ 'images/hero.png' ]
|
||||
|
||||
# Admin options for social media.
|
||||
# Default: not set
|
||||
# Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's
|
||||
# implementation. See the Hugo docs for possible values.
|
||||
social.facebook_admin = ''
|
||||
social.twitter = ''
|
||||
|
||||
###############################################################################
|
||||
# Relearn Theme
|
||||
# These options are specific to the Relearn theme.
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Branding
|
||||
# These options set your overall visual appearance.
|
||||
|
||||
# Used color variants.
|
||||
# Default: 'auto'
|
||||
# This sets one or more color variants, available to your readers to choose
|
||||
# from. You can
|
||||
# - set a single value eg. 'zen-light'
|
||||
# - an array like [ 'neon', 'learn' ]
|
||||
# - an array with options like [ { identifier = 'neon' },{ identifier = 'learn' } ]
|
||||
# The last form allows to set further options for each variant.
|
||||
# The `identifier` is mandatory. You can also set `name` which overrides the
|
||||
# value displayed in the variant selector.
|
||||
# If the array has more than one entry, a variant selector
|
||||
# is shown in the lower part of the menu. The first entry in the array is the
|
||||
# default variant, used for first time visitors.
|
||||
# The theme ships with the following variants: 'relearn-bright',
|
||||
# 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn',
|
||||
# 'blue', 'green', 'red'. In addition you can use auto mode variants. See the
|
||||
# docs for a detailed explanation.
|
||||
# You can also define your own variants. See the docs how this works. Also,
|
||||
# the docs provide an interactive theme generator to help you with this task.
|
||||
themeVariant = [
|
||||
{ identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [ 'relearn-light', 'relearn-dark' ] },
|
||||
{ identifier = 'relearn-dark' },
|
||||
{ identifier = 'relearn-light' },
|
||||
{ identifier = 'relearn-bright' },
|
||||
{ identifier = 'zen-auto', name = 'Zen Light/Dark', auto = [ 'zen-light', 'zen-dark' ] },
|
||||
{ identifier = 'zen-dark' },
|
||||
{ identifier = 'zen-light' },
|
||||
{ identifier = 'retro-auto', name = 'Retro Learn/Neon', auto = [ 'learn', 'neon' ] },
|
||||
{ identifier = 'neon' },
|
||||
{ identifier = 'learn' },
|
||||
{ identifier = 'blue' },
|
||||
{ identifier = 'green' },
|
||||
{ identifier = 'red' }
|
||||
]
|
||||
|
||||
# Minify theme assets.
|
||||
# Default: not set
|
||||
# If set to `true`, further theme asset files besides the generated HTML files
|
||||
# will be minified during build. If no value is set, the theme will avoid
|
||||
# minification if you have started with `hugo server` and otherwise will minify.
|
||||
minify = ""
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# General
|
||||
# These options are defining general, non visual behavior.
|
||||
|
||||
# Avoid new asset URLs on build.
|
||||
# Default: false
|
||||
# By default JavaScript-files and CSS-files get a unique ID on each rebuild.
|
||||
# This makes sure, the user always has the latest version and not some stale
|
||||
# copy of his browser cache. Anyways, it can be desireable to turn this
|
||||
# off in certain circumstances. For example if you have Hugo's dev server
|
||||
# running. Also some proxies dislike this optimization.
|
||||
disableAssetsBusting = false
|
||||
|
||||
# Avoid generator meta tags.
|
||||
# Default: false
|
||||
# Set this to true if you want to disable generation for generator meta tags
|
||||
# of Hugo and the theme in your HTML head. In this case also don't forget to
|
||||
# set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a
|
||||
# meta tag into your home page anyways.
|
||||
disableGeneratorVersion = false
|
||||
|
||||
# Avoid unique IDs.
|
||||
# Default: false
|
||||
# In various situations the theme generates non stable unique ids to be used
|
||||
# in HTML fragment links. This can be undesirable for example when testing
|
||||
# the output for changes. If you disable the random id generation, the theme
|
||||
# may not function correctly anymore.
|
||||
disableRandomIds = false
|
||||
|
||||
# Conditionally ignore errorlevel settings
|
||||
# Default: []
|
||||
# The theme supports checking referenced address (e.g. with
|
||||
# link.errorlevel, image.errorlevel, etc. see below). Sometimes checks lead
|
||||
# to console output due to false negatives. You can turn off the checks
|
||||
# for individual referenced addresses by defining regular expressions here.
|
||||
# The referenced address will be checked against all regexes of this array.
|
||||
# If it matches at least one, no output will be written to the console.
|
||||
# This array can be expanded in the page's frontmatter.
|
||||
errorignore = []
|
||||
|
||||
# Additional code dependencies.
|
||||
# Default: See hugo.toml of the theme
|
||||
# The theme provides a mechanism to load further JavaScript and CSS
|
||||
# dependencies on demand only if they are needed. This comes in handy if you
|
||||
# want to add own shortcodes that depend on additional code to be loaded.
|
||||
# See the docs how this works.
|
||||
# [relearn.dependencies]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Topbar
|
||||
# These options modify the topbar appearance.
|
||||
|
||||
# Hide the table of contents button.
|
||||
# Default: false
|
||||
# If the TOC button is hidden, also the keyboard shortcut is disabled.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disableToc = false
|
||||
|
||||
# Hide the breadcrumbs.
|
||||
# Default: false
|
||||
# If the breadcrumbs are hidden, the title of the displayed page will still be
|
||||
# shown in the topbar.
|
||||
disableBreadcrumb = false
|
||||
|
||||
# Hide the Markdown button.
|
||||
# Default: false
|
||||
# This hides the Markdown button if you activated the Markdown output format.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disableMarkdownButton = false
|
||||
|
||||
# Hide the Source button.
|
||||
# Default: false
|
||||
# This hides the Source button if you activated the Source output format.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disableSourceButton = false
|
||||
|
||||
# Hide the Print button.
|
||||
# Default: false
|
||||
# This hides the print button if you activated the print output format.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disablePrintButton = false
|
||||
|
||||
# Hide Next and Previous navigation buttons.
|
||||
# Default: false
|
||||
# If the navigation buttons are hidden, also the keyboard shortcuts are
|
||||
# disabled.
|
||||
disableNextPrev = false
|
||||
|
||||
# The URL prefix to edit a page.
|
||||
# Default: not set
|
||||
# If set, an edit button will be shown in the topbar. If the button is hidden,
|
||||
# also the keyboard shortcuts are disabled. The value can contain the macro
|
||||
# `${FilePath}` which will be replaced by the file path of your displayed page.
|
||||
# If no `${FilePath}` is given in the value, the value is treated as if the
|
||||
# `${FilePath}` was appended at the end of the value. This can be overridden
|
||||
# in the pages frontmatter. This is useful if you want to give the opportunity
|
||||
# for people to create merge request for your content.
|
||||
editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Search
|
||||
# These options modify various aspects of the search functionality.
|
||||
|
||||
# Disable the search.
|
||||
# Default: false
|
||||
# If the search is disabled, no search box will be displayed in the menu,
|
||||
# nor in-page search, search popup or dedicated search page will be available.
|
||||
# This will also cause the keyboard shortcut to be disabled.
|
||||
disableSearch = false
|
||||
|
||||
# Disable the search index generation.
|
||||
# Default: false
|
||||
# `disableSearch=false` must be set to let the generation of the search index
|
||||
# file to be affected by this option. If the search index is disabled, no
|
||||
# search popup or dedicated search page will be available.
|
||||
disableSearchIndex = false
|
||||
|
||||
# URL of the search index file relative to the language home.
|
||||
# Default: 'searchindex.js'
|
||||
# You have to set this option if your page already has a content file named
|
||||
# `searchindex.js` in the language home.
|
||||
searchIndexURL = 'searchindex.js'
|
||||
|
||||
# Disable the dedicated search page.
|
||||
# Default: false
|
||||
# `disableSearch=false` and `disableSearchIndex=false` must be set to let the
|
||||
# generation of the dedicated search page to be affected by this option.
|
||||
disableSearchPage = false
|
||||
|
||||
# URL of the dedicated search page relative to the language home.
|
||||
# Default: 'search'
|
||||
# In its basic form the search page URL is named the same for all languages
|
||||
# but you are free to override it in each language options to localised the
|
||||
# URL. You also need to set this option if your page already has a content
|
||||
# page named `search`.
|
||||
searchPageURL = 'search'
|
||||
|
||||
# Multilanguage content.
|
||||
# Default: not set
|
||||
# If the search index is enabled and your pages contain further languages
|
||||
# besides the main one used, add all those auxiliary languages here. This
|
||||
# will create a search index with support for all used languages of your site.
|
||||
# This is handy for example if you are writing in Spanish but have lots of
|
||||
# source code on your page which typically uses English terminology.
|
||||
additionalContentLanguage = [ 'en' ]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Menu
|
||||
# These options modify the menu appearance.
|
||||
|
||||
# Hide the Home entry.
|
||||
# Default: false
|
||||
# If shown, a Home button will appear below the search bar and the main menu.
|
||||
# It links to your the home page of the current language.
|
||||
disableLandingPageButton = true
|
||||
|
||||
# Hide the language switcher.
|
||||
# Default: false
|
||||
# If you have more than one language configured, a language switcher is
|
||||
# displayed in the lower part of the menu. This option lets you explicitly
|
||||
# turn this behavior off.
|
||||
disableLanguageSwitchingButton = false
|
||||
|
||||
# Shows checkmarks for visited pages of the main menu.
|
||||
# Default: false
|
||||
# This also causes the display of the `Clear History` entry in the lower part
|
||||
# of the menu to remove all checkmarks. The checkmarks will also been removed
|
||||
# if you regenerate your site as the ids are not stable.
|
||||
showVisitedLinks = true
|
||||
|
||||
# The order of main menu submenus.
|
||||
# Default: 'weight'
|
||||
# Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate',
|
||||
# 'expirydate', 'publishdate', 'date', 'length' or 'default' (adhering to
|
||||
# Hugo's default sort order). This can be overridden in the pages frontmatter.
|
||||
ordersectionsby = 'weight'
|
||||
|
||||
# The initial expand state of submenus.
|
||||
# Default: not set
|
||||
# This controls whether submenus will be expanded (true), or collapsed (false)
|
||||
# in the menu. If not set, the first menu level is set to false, all others
|
||||
# levels are set to true. This can be overridden in the page's frontmatter.
|
||||
# If the displayed page has submenus, they will always been displayed expanded
|
||||
# regardless of this option.
|
||||
alwaysopen = ''
|
||||
|
||||
# Shows expander for submenus.
|
||||
# Default: false
|
||||
# If set to true, a submenu in the sidebar will be displayed in a collapsible
|
||||
# tree view and a clickable expander is set in front of the entry.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
collapsibleMenu = true
|
||||
|
||||
# Hide heading above the shortcuts menu.
|
||||
# Default: false
|
||||
# If a sidebar menu with identifier `shortcuts` is configured (see below),
|
||||
# this is the easy way to remove the heading;
|
||||
# The title for the heading can be overwritten in your i18n files. See Hugo's
|
||||
# documentation how to do this.
|
||||
disableShortcutsTitle = false
|
||||
|
||||
# Define your own sidebar menus.
|
||||
# Default: the value used below
|
||||
# The sidebar menus are built from this parameter. If not set, it contains
|
||||
# the below default.
|
||||
# Menus are written from the sidebar's top to buttom in the order given in
|
||||
# this array.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
# Each entry can contain the following keys:
|
||||
# - `type` is mandatory. Either `page` in case it should generate a tre from
|
||||
# the page structure or `menu` in case it should generate a tree from a
|
||||
# defined menu.
|
||||
# - `identifier` is mandatory. In case of `type=page`, anything can be used,
|
||||
# in case of `type=menu` the `identifier` key must be identical to the
|
||||
# key of the menu definition.
|
||||
# - `main`, boolean. If `true`, the first tree level is spaced more generous
|
||||
# and the text is emphasized. Default: `true` for `type=page` and `false`
|
||||
# for `type=menu`
|
||||
# - `disableTitle`, boolean. If `true`, there is no title above the tree.
|
||||
# Default: `true` for `type=page` and `false` for `type=menu`. If a title
|
||||
# should be used, in case of `type=page` it will be taken from the page's
|
||||
# `menuTitle` front matter and if not set, from the translation files, using
|
||||
# the menu `identifier` as key. In case of `type=menu` it will be taken
|
||||
# from the menu `title` according to Hugo's documentation and if not set
|
||||
# from the menu `name` and if this is not set form the page's `linkTitle`.
|
||||
# - `pageRef`, optional. In case of `type=page` this is the starting page's
|
||||
# path. If not set, the home page will be used.
|
||||
sidebarmenus = [
|
||||
{ type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' },
|
||||
{ type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false },
|
||||
]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Hidden pages
|
||||
# These options configure how hidden pages are treated.
|
||||
# A page flagged as hidden, is only removed from the main menu if you are
|
||||
# currently not on this page or the hidden page is not part of current page's
|
||||
# ancestors. For all other functionality in Hugo a hidden page behaves like any
|
||||
# other page if not otherwise configured.
|
||||
|
||||
# Hide hidden pages from search.
|
||||
# Default: false
|
||||
# Hides hidden pages from the suggestions of the search box and the dedicated
|
||||
# search page.
|
||||
disableSearchHiddenPages = false
|
||||
|
||||
# Hide hidden pages for web crawlers.
|
||||
# Default: false
|
||||
# Avoids hidden pages from showing up in the sitemap and on Google (et all),
|
||||
# otherwise they may be indexed by search engines
|
||||
disableSeoHiddenPages = true
|
||||
|
||||
# Hide hidden pages for taxonomies.
|
||||
# Default: false
|
||||
# Hides hidden pages from showing up on the taxonomy and terms pages. If this
|
||||
# reduces term counters to zero, an empty but not linked term page will be
|
||||
# created anyhow.
|
||||
disableTagHiddenPages = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Content
|
||||
# These options modify how your content is displayed.
|
||||
|
||||
# Title separator.
|
||||
# Default: '::'
|
||||
# Changes the title separator used when concatenating the page title with the
|
||||
# site title. This is consistently used throughout the theme.
|
||||
titleSeparator = '::'
|
||||
|
||||
# Breadcrumb separator.
|
||||
# Default: '>'
|
||||
# Changes the breadcrumb separator used in the topbars breadcrumb area and for
|
||||
# search results and term pages.
|
||||
breadcrumbSeparator = '>'
|
||||
|
||||
# Hide the root breadcrumb.
|
||||
# Default: false
|
||||
# The root breadcrumb is usually the home page of your site. Because this is
|
||||
# always accessible by clicking on the logo, you may want to reduce clutter
|
||||
# by removing this from your breadcrumb.
|
||||
disableRootBreadcrumb = true
|
||||
|
||||
# Hide breadcrumbs term pages.
|
||||
# Default: false
|
||||
# If you have lots of taxonomy terms, the term pages may seem cluttered with
|
||||
# breadcrumbs to you, so this is the option to turn off breadcrumbs on term
|
||||
# pages. Only the page title will then be shown on the term pages.
|
||||
disableTermBreadcrumbs = false
|
||||
|
||||
# Disable copying heading links to clipboard
|
||||
# Default: false
|
||||
# If set to true, this disables the copying of anchor links to the clipboard;
|
||||
# if also `disableAnchorScrolling=true` then no anchor link will be visible
|
||||
# when hovering a heading.
|
||||
disableAnchorCopy = false
|
||||
|
||||
# Disable scrolling to heading link on click
|
||||
# Default: false
|
||||
# If set to true, this disables the scrolling to the beginning of the heading
|
||||
# when clicked; if also `disableAnchorCopy=true` then no anchor link will
|
||||
# be visible when hovering a heading.
|
||||
disableAnchorScrolling = false
|
||||
|
||||
# User-defined styles for shortcodes
|
||||
# Default: not set
|
||||
# Besides the predefined `style` values, you are able to define your own. The
|
||||
# `style` parameter of the shortcode must match the `identifier` defined here.
|
||||
# The title for the style will be determined from the `title`. If no `title`
|
||||
# but a `i18n` is set, the title will be taken from the translation files by
|
||||
# that key. The `title` may be empty in which case, the box does not contain a
|
||||
# default title. `icon` and `color` are working similar.
|
||||
boxStyle = [
|
||||
{ identifier = 'magic', i18n = '', title = 'Magic', icon = 'rainbow', color = 'gold' }
|
||||
]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Highlight
|
||||
# These options configure how code is displayed.
|
||||
|
||||
# Hide copy-to-clipboard for inline code.
|
||||
# Default: false
|
||||
# This removes the copy-to-clipboard button from your inline code.
|
||||
disableInlineCopyToClipBoard = true
|
||||
|
||||
# Always show copy-to-clipboard for block code.
|
||||
# Default: false
|
||||
# The theme only shows the copy-to-clipboard button if you hover over the code
|
||||
# block. Set this to true to disable the hover effect and always show the
|
||||
# button.
|
||||
disableHoverBlockCopyToClipBoard = false
|
||||
|
||||
# Wrap for code blocks.
|
||||
# Default: true
|
||||
# By default lines of code blocks wrap around if the line is too long to be
|
||||
# displayed on screen. If you dislike this behavior, you can reconfigure it
|
||||
# here.
|
||||
# Note that lines always wrap in print mode regardless of this option.
|
||||
# This can be overridden in the page's frontmatter or given as a parameter to
|
||||
# individual code blocks.
|
||||
highlightWrap = true
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Include
|
||||
# These options configure how the include shortcode works.
|
||||
|
||||
# What to do when path is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a path can not be resolved to as
|
||||
# a resource or via the file system. If not set, no output will be written
|
||||
# for the unresolved path. If set to `warning` the same happens and an additional
|
||||
# warning is printed. If set to `error` an error message is printed and the build
|
||||
# is aborted.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
include.errorlevel = 'warning'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Images
|
||||
# These options configure how images are displayed.
|
||||
|
||||
# What to do when local image link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local image can not be resolved to as
|
||||
# a resource. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that this can not resolve files inside of your `static` directory.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
image.errorlevel = 'warning'
|
||||
|
||||
# Image effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effects can be overridden in the page's frontmatter or through URL parameter
|
||||
# given to the image. See the documentation for details.
|
||||
|
||||
# Default: false
|
||||
imageEffects.border = true
|
||||
# Default: false
|
||||
imageEffects.dataurl = false
|
||||
# Default: false
|
||||
imageEffects.inlinecontent = false
|
||||
# Default: true
|
||||
imageEffects.lazy = true
|
||||
# Default: true
|
||||
imageEffects.lightbox = true
|
||||
# Default: false
|
||||
imageEffects.shadow = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Links
|
||||
# These options configure how links are displayed.
|
||||
|
||||
# Wether to use Hugo's default relref shortcode implementation
|
||||
# Default: false
|
||||
# Since the theme provides a link render hook, the usage of the relref shortcode
|
||||
# is obsolete. If a site still uses that shortcode, it fails to generate a
|
||||
# correct links if the baseURL is configured with a subdirectory and relativeURLs=false.
|
||||
# The theme provides an overriden relref shortcode that also works in the
|
||||
# above setup but must manually be activated by setting this option to true.
|
||||
# See discussion in https://github.com/McShelby/hugo-theme-relearn/discussions/862
|
||||
disableDefaultRelref = false
|
||||
|
||||
# Generate link URLs the Hugo way.
|
||||
# Default: false
|
||||
# If set to true, the theme behaves like a standard Hugo installation and
|
||||
# appends no index.html to prettyURLs. As a trade off, your build project will
|
||||
# not be servable from the file system.
|
||||
disableExplicitIndexURLs = false
|
||||
|
||||
# How to open external links.
|
||||
# Default: '_blank'
|
||||
# For external links you can define how they are opened in your browser. All
|
||||
# values for the HTML `target` attribute of the `a` element are allowed. The
|
||||
# default value opens external links in a separate browser tab. If you want
|
||||
# to open those links in the same tab, use '_self'.
|
||||
# If you want to set the default behavior for all links, use link effects.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
externalLinkTarget = '_self'
|
||||
|
||||
# What to do when local page link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local link can not be resolved to a
|
||||
# page. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that with Hugo < 0.123.0 + `uglyURLs=true` this can lead to false
|
||||
# negatives.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
link.errorlevel = 'warning'
|
||||
|
||||
# Link effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effects can be overridden in the page's frontmatter or through URL parameter
|
||||
# given to the link. See the documentation for details.
|
||||
|
||||
# Default: false
|
||||
linkEffects.download = false
|
||||
# Default: false
|
||||
linkEffects.target = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# MathJax
|
||||
# These options configure how math formulae are displayed.
|
||||
|
||||
# Initialization options for MathJax.
|
||||
# Default: not set
|
||||
# A JSON value. See the MathJaxdocumentation for possible parameter.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
mathJaxInitialize = '{}'
|
||||
|
||||
# Force load Math on every page.
|
||||
# Default: false
|
||||
# If a, Math shortcode or codefence is found, the option will be ignored and
|
||||
# Math will be loaded regardlessly. This option is useful in case you
|
||||
# are using passthrough configuration to render your math. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `math=true`.
|
||||
# This option has an alias `math.force`.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
math = false
|
||||
|
||||
# URL for external MathJax library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the MathJax library. By default the shipped
|
||||
# version will be used.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Mermaid
|
||||
# These options configure how Mermaid graphs are displayed.
|
||||
|
||||
# Make graphs panable and zoomable
|
||||
# Default: false
|
||||
# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
|
||||
# with a reset button for the zoom.
|
||||
# This can be overridden in the page's frontmatter or given as a parameter to
|
||||
# individual graphs.
|
||||
mermaidZoom = true
|
||||
|
||||
# Initialization options for Mermaid.
|
||||
# Default: not set
|
||||
# A JSON value. See the Mermaid documentation for possible parameter.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
mermaidInitialize = '{ "securityLevel": "loose" }'
|
||||
|
||||
# Force load Mermaid on every page.
|
||||
# Default: false
|
||||
# If a Mermaid shortcode or codefence is found, the option will be ignored and
|
||||
# Mermaid will be loaded regardlessly. This option is useful in case you
|
||||
# are using scripting to render your graph. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `mermaid.force=true`.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
mermaid.force = false
|
||||
|
||||
# URL for external Mermaid library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the Mermaid library. By default the shipped
|
||||
# version will be used.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# OpenApi
|
||||
# These options configure how OpenAPI specifications are displayed.
|
||||
|
||||
# Force load OpenAPI on every page.
|
||||
# Default: false
|
||||
# If a, OpenAPI shortcode or codefence is found, the option will be ignored and
|
||||
# OpenAPI will be loaded regardlessly. This option is useful in case you
|
||||
# are using scripting to render your spec. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `openapi.force=true`.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
openapi.force = false
|
||||
|
||||
# URL for external OpenAPI library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the OpenAPI library. By default the shipped
|
||||
# version will be used.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'
|
||||
|
||||
# What to do when a local OpenAPI spec link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local OpenAPI spec link can not be resolved
|
||||
# to a resource. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that this can not resolve files inside of your `static` directory.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
openapi.errorlevel = 'warning'
|
||||
4
themes/hugo-theme-relearn/docs/config/github/hugo.toml
Normal file
4
themes/hugo-theme-relearn/docs/config/github/hugo.toml
Normal file
@@ -0,0 +1,4 @@
|
||||
# Configuration to release this site on GitHub Pages
|
||||
|
||||
baseURL = 'https://mcshelby.github.io/hugo-theme-relearn/'
|
||||
relativeURLs = false
|
||||
25
themes/hugo-theme-relearn/docs/config/testing/hugo.toml
Normal file
25
themes/hugo-theme-relearn/docs/config/testing/hugo.toml
Normal file
@@ -0,0 +1,25 @@
|
||||
# Configuration to test the exampleSite for changes in development
|
||||
# This configuration will not result in a functioning website.
|
||||
|
||||
# We disable this for testing; you must do so too
|
||||
# if you want to use the themes parameter disableGeneratorVersion=true;
|
||||
# otherwise Hugo will create a generator tag on your home page
|
||||
disableHugoGeneratorInject = true
|
||||
|
||||
# We are pretty sure, to not have unintentionally untranslated titles;
|
||||
# it may happen in case when shortcodes want to set an automatic title
|
||||
# out of a given style setting (this is allowed to fail for non severity styles)
|
||||
# enableMissingTranslationPlaceholders = true
|
||||
|
||||
# Audit your published site for problems
|
||||
# https://discourse.gohugo.io/t/audit-your-published-site-for-problems/35184/12
|
||||
[minify]
|
||||
[minify.tdewolff]
|
||||
[minify.tdewolff.html]
|
||||
keepComments = true
|
||||
|
||||
[params]
|
||||
disableGeneratorVersion = true
|
||||
disableAssetsBusting = true
|
||||
disableRandomIds = true
|
||||
minify = false
|
||||
14
themes/hugo-theme-relearn/docs/content/_index.en.md
Normal file
14
themes/hugo-theme-relearn/docs/content/_index.en.md
Normal file
@@ -0,0 +1,14 @@
|
||||
+++
|
||||
description = "A theme for Hugo designed for documentation."
|
||||
title = "Hugo Relearn Theme"
|
||||
type = "home"
|
||||
[[cascade]]
|
||||
[cascade._target]
|
||||
path = "/introduction/changelog/*/*/*"
|
||||
[cascade.params]
|
||||
[cascade.params._build]
|
||||
render = "never"
|
||||
+++
|
||||
{{% replaceRE "https://mcshelby.github.io/hugo-theme-relearn/" "" %}}
|
||||
{{< include "README.md" "true" >}}
|
||||
{{% /replaceRE %}}
|
||||
12
themes/hugo-theme-relearn/docs/content/_index.pir.md
Normal file
12
themes/hugo-theme-relearn/docs/content/_index.pir.md
Normal file
@@ -0,0 +1,12 @@
|
||||
+++
|
||||
description = "A theme fer Cap'n Hugo designed fer documentat'n."
|
||||
title = "Cap'n Hugo Relearrrn Theme"
|
||||
type = "home"
|
||||
[[cascade]]
|
||||
[cascade._target]
|
||||
path = "/introduction/changelog/*/*/*"
|
||||
[cascade.params]
|
||||
[cascade.params._build]
|
||||
render = "never"
|
||||
+++
|
||||
{{< piratify true >}}
|
||||
@@ -0,0 +1,11 @@
|
||||
+++
|
||||
categories = ["reference"]
|
||||
menuPre = "<i class='fa-fw fab fa-markdown'></i> "
|
||||
title = "Authoring"
|
||||
type = "chapter"
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
Learn how to create and organize your content pages.
|
||||
|
||||
{{% children containerstyle="div" style="h2" description=true %}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["reference"]
|
||||
menuPre = "<i class='fa-fw fab fa-markdown'></i> "
|
||||
title = "Rambl'n"
|
||||
type = "chapter"
|
||||
weight = 3
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,9 @@
|
||||
+++
|
||||
alwaysopen = false
|
||||
categories = ["reference"]
|
||||
description = "All things front matter"
|
||||
title = "Front Matter"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
{{% children containerstyle="div" style="h2" description=true %}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
alwaysopen = false
|
||||
categories = ["reference"]
|
||||
description = "All things front matter"
|
||||
title = "Front Matter"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,87 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "How to vary layouts by using page designs"
|
||||
title = "Page Designs"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
Page designs are used to provide different layouts for your pages.
|
||||
|
||||
A page is displayed by exactly one page design and is represented by [Hugo's reserved `type` front matter](https://gohugo.io/content-management/front-matter/#type).
|
||||
|
||||
The Relearn theme ships with the page designs `home`, `chapter`, and `default` for the HTML output format but you can [define further custom page designs](configuration/customization/designs).
|
||||
|
||||
## Using a Page Design
|
||||
|
||||
Regardless of shipped or custom page design, you are using them in the same way.
|
||||
|
||||
- If you have an [archetype file](https://gohugo.io/content-management/archetypes/), you can just do
|
||||
|
||||
````shell
|
||||
hugo new --kind chapter log/_index.md
|
||||
````
|
||||
|
||||
- If you are creating your Markdown files manually, you can achieve the same by just setting `type='chapter'` in the front matter to make your page displayed with the `chapter` page design.
|
||||
|
||||
````toml {title="log/_index.md"}
|
||||
+++
|
||||
title = "Captain's Log"
|
||||
type = "chapter"
|
||||
+++
|
||||
````
|
||||
|
||||
If no `type` is set in your front matter or the page design doesn't exist for a given output format, the page is treated as if `type='default'` was set.
|
||||
|
||||
## Predefined Designs for the HTML Output Format
|
||||
|
||||
### Home {#archetypes-home}
|
||||
|
||||
A **Home** page is the starting page of your project. It's best to have only one page of this kind in your project.
|
||||
|
||||
To create a home page, run the following command
|
||||
|
||||
````shell
|
||||
hugo new --kind home _index.md
|
||||
````
|
||||
|
||||

|
||||
|
||||
### Chapter {#archetypes-chapter}
|
||||
|
||||
A **Chapter** displays a page meant to be used as introduction for a set of child pages.
|
||||
|
||||
Commonly, it contains a title front matter and a short description in the content.
|
||||
|
||||
To create a chapter page, run the following command
|
||||
|
||||
````shell
|
||||
hugo new --kind chapter log/_index.md
|
||||
````
|
||||
|
||||
If a numerical `weight` front matter is set, it will be used to generate the subtitle of the chapter page. Set the number to a consecutive value starting at 1 for each new chapter on the same directory level.
|
||||
|
||||

|
||||
|
||||
### Default {#archetypes-default}
|
||||
|
||||
A **Default** page is any other content page.
|
||||
|
||||
To create a default page, run either one of the following commands
|
||||
|
||||
````shell
|
||||
hugo new log/first-day/_index.md
|
||||
````
|
||||
|
||||
or
|
||||
|
||||
````shell
|
||||
hugo new log/second-day/index.md
|
||||
````
|
||||
|
||||
or
|
||||
|
||||
````shell
|
||||
hugo new log/third-day.md
|
||||
````
|
||||
|
||||

|
||||
@@ -0,0 +1,7 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "How to vary layouts by using page designs"
|
||||
title = "Page Designs"
|
||||
weight = 1
|
||||
+++
|
||||
{{< piratify >}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 124 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
@@ -0,0 +1,43 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "What options are available for links and images"
|
||||
frontmatter = ["errorignore", "externalLinkTarget", "image.errorlevel", "link.errorlevel"]
|
||||
options = ["errorignore", "externalLinkTarget", "image.errorlevel", "link.errorlevel"]
|
||||
title = "Linking"
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
## Opening Links
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} By default, external links open in a new tab. To change this, use the `externalLinkTarget` setting with a proper [link target](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
|
||||
|
||||
To set default values for all links, use [link effects](authoring/linkeffects).
|
||||
|
||||
For example, this will open links in the same tab
|
||||
|
||||
{{< multiconfig >}}
|
||||
externalLinkTarget = '_self'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Enabling Link and Image Link Warnings
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can use `link.errorlevel` and `image.errorlevel` to control what should happen if a local link can not be resolved to a page and/or a resource.
|
||||
|
||||
If not set or empty, any unresolved link is written as given into the resulting output. If set to `warning` the same happens and an additional warning is printed in the built console. If set to `error` an error message is printed and the build is aborted.
|
||||
|
||||
Please note that this can not resolve files inside of your `static` directory. The file must be a resource of the page or the site.
|
||||
|
||||
Link warnings are also available for the [include](shortcodes/include#enabling-link-warnings) and [openapi](shortcodes/openapi#enabling-link-warnings) shortcodes.
|
||||
|
||||
{{< multiconfig >}}
|
||||
link.errorlevel = 'warning'
|
||||
image.errorlevel = 'warning'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
### Ignoring False Negatives
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} In case you want to use link warnings but are bothered by false negatives, you can configure an ignore list of regular expressions. The referenced address will be checked against all regexes of this list. If the address matches at least one regex, no output will be written to the console. The check uses [Hugo's `findRE` function](https://gohugo.io/functions/strings/findre/).
|
||||
|
||||
{{< multiconfig >}}
|
||||
errorignore = [ '^/authoring/', '^/configuration/' ]
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,9 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "What options are available for links and images"
|
||||
frontmatter = ["errorignore", "externalLinkTarget", "image.errorlevel", "link.errorlevel"]
|
||||
options = ["errorignore", "externalLinkTarget", "image.errorlevel", "link.errorlevel"]
|
||||
title = "Linking"
|
||||
weight = 3
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
description = "Setting the behavior of the menus"
|
||||
title = "Menus"
|
||||
weight = 2
|
||||
menuPageRef = '/configuration/sidebar/menus#expand-state-of-submenus'
|
||||
+++
|
||||
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
description = "Setting the behavior of the menus"
|
||||
title = "Menus"
|
||||
weight = 2
|
||||
menuPageRef = '/configuration/sidebar/menus#expand-state-of-submenus'
|
||||
+++
|
||||
@@ -0,0 +1,38 @@
|
||||
+++
|
||||
categories = ["reference"]
|
||||
description = "All front matter for the Relearn theme"
|
||||
linkTitle = "Reference"
|
||||
title = "Front Matter Reference"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
Every Hugo page must have front matter.
|
||||
|
||||
In addition to [Hugo's standard front matter](https://gohugo.io/content-management/front-matter/#fields), the Relearn theme offers extras settings listed here.
|
||||
|
||||
Throughout the documentation, theme-specific front matter is marked with a {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} badge.
|
||||
|
||||
Add theme front matter directly to the root of your page's front matter. For example:
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
math = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Index
|
||||
|
||||
{{% taxonomy "frontmatter" "h3" %}}
|
||||
|
||||
## All Front Matter
|
||||
|
||||
Here's a list of all available front matter with example values. Default values are described in the [annotated example](#annotated-front-matter) below or in each front matter's documentation.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
{{% include "frontmatter.toml" %}}
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Annotated Front Matter
|
||||
|
||||
````toml {title="toml"}
|
||||
+++
|
||||
{{% include "frontmatter.toml" %}}+++
|
||||
````
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["reference"]
|
||||
description = "All front matter for the Relearn theme"
|
||||
linkTitle = "Reference"
|
||||
title = "Front Matter Reference"
|
||||
weight = 5
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,425 @@
|
||||
# If an option value is said to be not set, you can achieve the same behavior
|
||||
# by giving it an empty string value.
|
||||
|
||||
###############################################################################
|
||||
# Hugo
|
||||
# These options usually apply to other themes as well.
|
||||
|
||||
# The social media image of your page.
|
||||
# Default: not set
|
||||
# This is used for generating social media meta information for the opengraph
|
||||
# protocol and twitter cards.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
images = [ 'images/hero.png' ]
|
||||
|
||||
# The title of your page.
|
||||
# Default: not set
|
||||
# A page without a title is treated as a hidden page.
|
||||
title = 'Example Page'
|
||||
|
||||
# The description of your page.
|
||||
# Default: not set
|
||||
# This is used for generating HTML meta tags, social media meta information
|
||||
# for the opengraph protocol and twitter cards.
|
||||
# If not set, the set value of your site's hugo.toml is used for the html
|
||||
# meta tag, social media meta information for the opengraph protocol and
|
||||
# twitter cards.
|
||||
description = ''
|
||||
|
||||
# The page design to be used
|
||||
# Default: not set
|
||||
# This decides the layout of your page. The theme ships 'home', 'chapter' and
|
||||
# 'default'. If not set, 'default' is taken.
|
||||
type = ''
|
||||
|
||||
###############################################################################
|
||||
# Relearn Theme
|
||||
# These options are specific to the Relearn theme.
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# General
|
||||
# These options are defining general, non visual behavior.
|
||||
|
||||
# Conditionally ignore errorlevel settings
|
||||
# Default: []
|
||||
# The theme supports checking referenced address (e.g. with
|
||||
# link.errorlevel, image.errorlevel, etc. see below). Sometimes checks lead
|
||||
# to console output due to false negatives. You can turn off the checks
|
||||
# for individual referenced addresses by defining regular expressions here.
|
||||
# The referenced address will be checked against all regexes of this array.
|
||||
# If it matches at least one, no output will be written to the console.
|
||||
# This array can be expanded globally in your site's hugo.toml.
|
||||
errorignore = []
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Topbar
|
||||
# These options modify the topbar appearance.
|
||||
|
||||
# Hide the table of contents button.
|
||||
# Default: false
|
||||
# If the TOC button is hidden, also the keyboard shortcut is disabled.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableToc = false
|
||||
|
||||
# Hide the breadcrumbs.
|
||||
# Default: false
|
||||
# If the breadcrumbs are hidden, the title of the displayed page will still be
|
||||
# shown in the topbar.
|
||||
disableBreadcrumb = false
|
||||
|
||||
# Hide the Markdown button.
|
||||
# Default: false
|
||||
# This hides the Markdown button if you activated the Markdown output format.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableMarkdownButton = false
|
||||
|
||||
# Hide the Source button.
|
||||
# Default: false
|
||||
# This hides the Source button if you activated the Source output format.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disableSourceButton = false
|
||||
|
||||
# Hide the Print button.
|
||||
# Default: false
|
||||
# This hides the print button if you activated the print output format.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
disablePrintButton = false
|
||||
|
||||
# Hide Next and Previous navigation buttons.
|
||||
# Default: false
|
||||
# If the navigation buttons are hidden, also the keyboard shortcuts are
|
||||
# disabled.
|
||||
disableNextPrev = false
|
||||
|
||||
# The URL prefix to edit a page.
|
||||
# Default: not set
|
||||
# If set, an edit button will be shown in the topbar. If the button is hidden,
|
||||
# also the keyboard shortcuts are disabled. The value can contain the macro
|
||||
# `${FilePath}` which will be replaced by the file path of your displayed page.
|
||||
# If not set, the set value of your site's hugo.toml is used. If the global
|
||||
# parameter is given but you want to hide the button for the displayed page,
|
||||
# you can set the value to an empty string. If instead of hiding you want to have
|
||||
# an disabled button, you can set the value to a string containing just spaces.
|
||||
# This is useful if you want to give the opportunity for people to create merge
|
||||
# request for your content.
|
||||
editURL = ''
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Menu
|
||||
# These options modify the menu appearance.
|
||||
|
||||
# Menu specific title
|
||||
# Default: not set
|
||||
# The title displayed in the menu. If not set the `title` front matter will
|
||||
# be used.
|
||||
linkTitle = ''
|
||||
|
||||
# Prefix for the title in navigation menu.
|
||||
# Default: not set
|
||||
# The title of the page in the menu will be prefixed by this HTML content.
|
||||
menuPre = ''
|
||||
|
||||
# Suffix for the title in navigation menu.
|
||||
# Default: not set
|
||||
# The title of the page in the menu will be suffixed by this HTML content.
|
||||
menuPost = ''
|
||||
|
||||
# Link the menu entry to a different internal page instead.
|
||||
# Default: not set
|
||||
# This will effectivly hide the page and its content from the viewer by
|
||||
# linking to the given URL instead.
|
||||
menuPageRef = ''
|
||||
|
||||
# Link the menu entry to an external URL instead of a page.
|
||||
# Default: not set
|
||||
# This will effectivly hide the page and its content from the viewer by
|
||||
# linking to the given URL instead.
|
||||
menuUrl = ''
|
||||
|
||||
# The order of navigation menu submenus.
|
||||
# Default: 'weight'
|
||||
# Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate',
|
||||
# 'expirydate', 'publishdate', 'date', 'length' or 'default' (adhering to
|
||||
# Hugo's default sort order).
|
||||
# If not set, the value of the parent menu entry is used.
|
||||
ordersectionsby = 'weight'
|
||||
|
||||
# The initial expand state of submenus.
|
||||
# Default: not set
|
||||
# This controls whether submenus will be expanded (true), or collapsed (false)
|
||||
# in the menu. If not set, the first menu level is set to false, all others
|
||||
# levels are set to true. If not set, the value of the parent menu entry is used.
|
||||
# If the displayed page has submenus, they will always been displayed expanded
|
||||
# regardless of this option.
|
||||
alwaysopen = ''
|
||||
|
||||
# Shows expander for submenus.
|
||||
# Default: false
|
||||
# If set to true, a submenu in the sidebar will be displayed in a collapsible
|
||||
# tree view and a clickable expander is set in front of the entry.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
collapsibleMenu = true
|
||||
|
||||
# Define your own sidebar menus.
|
||||
# Default: the value used below
|
||||
# The sidebar menus are built from this parameter. If not set, the set value
|
||||
# of your site's hugo.toml is used and contains the below default.
|
||||
# Menus are written from the sidebar's top to buttom in the order given in
|
||||
# this array.
|
||||
# Each entry can contain the following keys:
|
||||
# - `type` is mandatory. Either `page` in case it should generate a tre from
|
||||
# the page structure or `menu` in case it should generate a tree from a
|
||||
# defined menu.
|
||||
# - `identifier` is mandatory. In case of `type=page`, anything can be used,
|
||||
# in case of `type=menu` the `identifier` key must be identical to the
|
||||
# key of the menu definition.
|
||||
# - `main`, boolean. If `true`, the first tree level is spaced more generous
|
||||
# and the text is emphasized. Default: `true` for `type=page` and `false`
|
||||
# for `type=menu`
|
||||
# - `disableTitle`, boolean. If `true`, there is no title above the tree.
|
||||
# Default: `true` for `type=page` and `false` for `type=menu`. If a title
|
||||
# should be used, in case of `type=page` it will be taken from the page's
|
||||
# `menuTitle` front matter and if not set, from the translation files, using
|
||||
# the menu `identifier` as key. In case of `type=menu` it will be taken
|
||||
# from the menu `title` according to Hugo's documentation and if not set
|
||||
# from the menu `name` and if this is not set form the page's `linkTitle`.
|
||||
# - `pageRef`, optional. In case of `type=page` this is the starting page's
|
||||
# path. If not set, the home page will be used.
|
||||
sidebarmenus = [
|
||||
{ type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' },
|
||||
{ type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false },
|
||||
]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Hidden pages
|
||||
# These options configure how hidden pages are treated.
|
||||
# A page flagged as hidden, is only removed from the navigation menu if you are
|
||||
# currently not on this page or the hidden page is not part of current page's
|
||||
# ancestors. For all other functionality in Hugo a hidden page behaves like any
|
||||
# other page if not otherwise configured.
|
||||
|
||||
# Hide a page's menu entry.
|
||||
# Default: false
|
||||
# If this value is true, the page is hidden from the menu.
|
||||
hidden = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Content
|
||||
# These options modify how your content is displayed.
|
||||
|
||||
# Prefix for the title in the content area.
|
||||
# Default: not set
|
||||
# The title of the page heading will be prefixed by this HTML content.
|
||||
headingPre = ''
|
||||
|
||||
# Suffix for the title in the content area.
|
||||
# Default: not set
|
||||
# The title of the page heading will be suffixed by this HTML content.
|
||||
headingPost = ''
|
||||
|
||||
# Display name of the page's last editor.
|
||||
# Default: not set
|
||||
# If set, it will be displayed in the default footer.
|
||||
LastModifierDisplayName = ''
|
||||
|
||||
# Email address of the page's last editor.
|
||||
# Default: not set
|
||||
# If set together with LastModifierDisplayName, it will be displayed in the
|
||||
# default footer.
|
||||
LastModifierEmail = ''
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Highlight
|
||||
# These options configure how code is displayed.
|
||||
|
||||
# Wrap for code blocks.
|
||||
# Default: true
|
||||
# By default lines of code blocks wrap around if the line is too long to be
|
||||
# displayed on screen. If you dislike this behavior, you can reconfigure it
|
||||
# here.
|
||||
# Note that lines always wrap in print mode regardless of this option.
|
||||
# If not set, the set value of your site's hugo.toml is used or given as a
|
||||
# parameter to individual code blocks.
|
||||
highlightWrap = true
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Include
|
||||
# These options configure how the include shortcode works.
|
||||
|
||||
# What to do when path is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a path can not be resolved to as
|
||||
# a resource or via the file system. If not set, no output will be written
|
||||
# for the unresolved path. If set to `warning` the same happens and an additional
|
||||
# warning is printed. If set to `error` an error message is printed and the build
|
||||
# is aborted.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
include.errorlevel = ''
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Images
|
||||
# These options configure how images are displayed.
|
||||
|
||||
# What to do when local image link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local image can not be resolved to as
|
||||
# a resource. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that this can not resolve files inside of your `static` directory.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
image.errorlevel = ''
|
||||
|
||||
# Image effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effect values default to the values of your site's hugo.toml and can be
|
||||
# overridden through URL parameter given to the image. See the documentation for
|
||||
# details.
|
||||
|
||||
# Default: false
|
||||
imageEffects.border = true
|
||||
# Default: false
|
||||
imageEffects.dataurl = false
|
||||
# Default: false
|
||||
imageEffects.inlinecontent = false
|
||||
# Default: true
|
||||
imageEffects.lazy = true
|
||||
# Default: true
|
||||
imageEffects.lightbox = true
|
||||
# Default: false
|
||||
imageEffects.shadow = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Links
|
||||
# These options configure how links are displayed.
|
||||
|
||||
# How to open external links.
|
||||
# Default: '_blank'
|
||||
# For external links you can define how they are opened in your browser. All
|
||||
# values for the HTML `target` attribute of the `a` element are allowed. The
|
||||
# default value opens external links in a separate browser tab. If you want
|
||||
# to open those links in the same tab, use '_self'.
|
||||
# If you want to set the default behavior for all links, use link effects.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
externalLinkTarget = '_self'
|
||||
|
||||
# What to do when local page link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local link can not be resolved to a
|
||||
# page. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that with Hugo < 0.123.0 + `uglyURLs=true` this can lead to false
|
||||
# negatives.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
link.errorlevel = ''
|
||||
|
||||
# Link effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effect values default to the values of your site's hugo.toml and can be
|
||||
# overridden through URL parameter given to the link. See the documentation for
|
||||
# details.
|
||||
|
||||
# Default: false
|
||||
linkEffects.download = false
|
||||
# Default: false
|
||||
linkEffects.target = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# MathJax
|
||||
# These options configure how math formulae are displayed.
|
||||
|
||||
# Initialization options for MathJax.
|
||||
# Default: not set
|
||||
# A JSON value. See the MathJaxdocumentation for possible parameter.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
mathJaxInitialize = '{}'
|
||||
|
||||
# Force load Math on every page.
|
||||
# Default: false
|
||||
# If a, Math shortcode or codefence is found, the option will be ignored and
|
||||
# Math will be loaded regardlessly. This option is useful in case you
|
||||
# are using passthrough configuration to render your math. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `math=true`.
|
||||
# This option has an alias `math.force`.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
math = false
|
||||
|
||||
# URL for external MathJax library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the MathJax library. By default the shipped
|
||||
# version will be used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Mermaid
|
||||
# These options configure how Mermaid graphs are displayed.
|
||||
|
||||
# Make graphs panable and zoomable
|
||||
# Default: false
|
||||
# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
|
||||
# with a reset button for the zoom.
|
||||
# If not set, the set value of your site's hugo.toml is used or given as a
|
||||
# parameter to individual graphs.
|
||||
mermaidZoom = true
|
||||
|
||||
# Initialization options for Mermaid.
|
||||
# Default: not set
|
||||
# A JSON value. See the Mermaid documentation for possible parameter.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
mermaidInitialize = '{ "securityLevel": "loose" }'
|
||||
|
||||
# Force load Mermaid on every page.
|
||||
# Default: false
|
||||
# If a Mermaid shortcode or codefence is found, the option will be ignored and
|
||||
# Mermaid will be loaded regardlessly. This option is useful in case you
|
||||
# are using scripting to render your graph. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `mermaid.force=true`.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
mermaid.force = false
|
||||
|
||||
# URL for external Mermaid library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the Mermaid library. By default the shipped
|
||||
# version will be used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# OpenApi
|
||||
# These options configure how OpenAPI specifications are displayed.
|
||||
|
||||
# Load OpenAPI on every page.
|
||||
# Default: false
|
||||
# If a, OpenAPI shortcode or codefence is found, the option will be ignored and
|
||||
# OpenAPI will be loaded regardlessly. This option is useful in case you
|
||||
# are using scripting to render your spec. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `openapi.force=true`.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
openapi.force = false
|
||||
|
||||
# URL for external OpenAPI library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the OpenAPI library. By default the shipped
|
||||
# version will be used.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'
|
||||
|
||||
# What to do when a local OpenAPI spec link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local OpenAPI spec link can not be resolved
|
||||
# to a resource. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that this can not resolve files inside of your `static` directory.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
openapi.errorlevel = ''
|
||||
@@ -0,0 +1,84 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "Configure the topbar"
|
||||
frontmatter = ["disableBreadcrumb", "disableNextPrev", "disableMarkdownButton", "disableSourceButton", "disablePrintButton", "disableToc", "editURL"]
|
||||
options = ["disableBreadcrumb", "disableNextPrev", "disableMarkdownButton", "disableSourceButton", "disablePrintButton", "disableToc", "editURL"]
|
||||
outputs = ["html", "rss", "print", "markdown", "source"]
|
||||
title = "Topbar"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
This page is about how to configure the topbar using configuration options. If you want to add further buttons or functionality, [see this section](configuration/customization/topbar).
|
||||
|
||||
Your topbar contains the following elements. Some of them are configuarable:
|
||||
|
||||
- {{% button style="transparent" icon="bars" %}}{{% /button %}} **sidebar**: opens the sidebar flyout if in mobile layout
|
||||
- {{% button style="transparent" icon="list-alt" %}}{{% /button %}} **toc**: [opens the table of contents in an overlay](#table-of-contents)
|
||||
- {{% button style="transparent" icon="empty" %}}{{% /button %}} **breadcrumb**: shows the clickable [breadcrumbs](#breadcrumbs)
|
||||
- {{% button style="transparent" icon="pen" %}}{{% /button %}} **edit**: browses to the editable page if the `editURL` [parameter is set](#edit-button)
|
||||
- {{% button style="transparent" icon="code" %}}{{% /button %}} **source**: browses to the [chapters source code](#source-button) if [source support](configuration/sitemanagement/outputformats#source-support) was activated
|
||||
- {{% button style="transparent" icon="fa-fw fab fa-markdown" %}}{{% /button %}} **markdown**: browses to the [chapters Markdown source](#markdown-button) if [markdown support](configuration/sitemanagement/outputformats#markdown-support) was activated
|
||||
- {{% button style="transparent" icon="print" %}}{{% /button %}} **print**: browses to the [chapters printable page](#print-button) if [print support](configuration/sitemanagement/outputformats#print-support) was activated
|
||||
- {{% button style="transparent" icon="chevron-left" %}}{{% /button %}} **prev**: browses to the [previous page](#arrow-navigation) if there is one
|
||||
- {{% button style="transparent" icon="chevron-right" %}}{{% /button %}} **next**: browses to the [next page](#arrow-navigation) if there is one
|
||||
- {{% button style="transparent" icon="ellipsis-v" %}}{{% /button %}} **more**: opens the overlay if screen space is limited
|
||||
|
||||
## Table of Contents
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set `disableToc=true` to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page's front matter.
|
||||
|
||||
{{< multiconfig >}}
|
||||
disableToc = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Breadcrumbs
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set `disableBreadcrumb=true` to hide the breadcrumb in the topbar.
|
||||
|
||||
Further breadcrumbs settings can be found in the [content configuration section](configuration/content/titles).
|
||||
|
||||
{{< multiconfig >}}
|
||||
disableBreadcrumb = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Edit Button
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} If `editURL` is set to a URL, an edit button will be shown in the topbar. If the button is hidden, also the keyboard shortcut is disabled.
|
||||
|
||||
The value can contain the macro `${FilePath}` which will be replaced by the file path of your displayed page. If no `${FilePath}` is given in the value, the value is treated as if the `${FilePath}` was appended at the end of the value. This can be overridden in the pages front matter.
|
||||
|
||||
{{< multiconfig >}}
|
||||
editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Markdown Button
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the Markdown button if the [Markdown output format](configuration/sitemanagement/outputformats/#markdown-support) is active by setting `disableMarkdownButton=true`.
|
||||
|
||||
{{< multiconfig >}}
|
||||
disableMarkdownButton = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Source Button
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the Source button if the [Source output format](configuration/sitemanagement/outputformats/#source-support) is active by setting `disableSourceButton=true`.
|
||||
|
||||
{{< multiconfig >}}
|
||||
disableSourceButton = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Print Button
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the print button if the [print output format](configuration/sitemanagement/outputformats/#print-support) is active by setting `disablePrintButton=true`.
|
||||
|
||||
{{< multiconfig >}}
|
||||
disablePrintButton = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Arrow Navigation
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the previous/next buttons by setting `disableNextPrev=true`. If the buttons are hidden, also the keyboard shortcuts are disabled.
|
||||
|
||||
{{< multiconfig >}}
|
||||
disableNextPrev = true
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,10 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "Configure the topbar"
|
||||
frontmatter = ["disableBreadcrumb", "disableNextPrev", "disableMarkdownButton", "disableSourceButton", "disablePrintButton", "disableToc", "editURL"]
|
||||
options = ["disableBreadcrumb", "disableNextPrev", "disableMarkdownButton", "disableSourceButton", "disablePrintButton", "disableToc", "editURL"]
|
||||
outputs = ["html", "rss", "print", "markdown", "source"]
|
||||
title = "Topbarrr"
|
||||
weight = 4
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,66 @@
|
||||
+++
|
||||
categories = ["explanation"]
|
||||
description = "How to apply effects to your images"
|
||||
frontmatter = ["imageEffects"]
|
||||
title = "Image Effects"
|
||||
weight = 6
|
||||
+++
|
||||
|
||||
The theme offers [effects](authoring/markdown#image-effects) for your linked images.
|
||||
|
||||
You can [define additional custom image effects and set defaults](configuration/customization/imageeffects) in your configuration.
|
||||
|
||||
The default image effects shipped with the theme are
|
||||
|
||||
| Name | Description |
|
||||
| ------------- | ----------------------------------------------------------------- |
|
||||
| border | Draws a light thin border around the image |
|
||||
| dataurl | if the linked image points to a resource, it is converted to a base64 encoded dataurl |
|
||||
| inlinecontent | if the linked image points to a SVG resource, the content will be used instead of an `<img>` element, this is useful for applying additional CSS styles to the elements inside of the SVG which is otherwise impossible |
|
||||
| lazy | Lets the image be lazy loaded |
|
||||
| lightbox | The image will be clickable to show it enlarged |
|
||||
| shadow | Draws a shadow around the image to make it appear hovered/glowing |
|
||||
|
||||
One way to use them is to add them as URL query parameter to each individually linked image.
|
||||
|
||||
This can become cumbersome to be done consistently for the whole site. Instead, you can [configure the defaults](configuration/customization/imageeffects) in your `hugo.toml` as well as overriding these defaults in a page's front matter.
|
||||
|
||||
Explicitly set URL query parameter will override the defaults set for a page or your site.
|
||||
|
||||
If an effect accepts boolean values, only setting the parameter name without a value in the URL will set it to `true`.
|
||||
|
||||
Without any settings in your `hugo.toml` `imageEffects` defaults to
|
||||
|
||||
{{< multiconfig >}}
|
||||
[imageEffects]
|
||||
border = false
|
||||
dataurl = false
|
||||
inlinecontent = false
|
||||
lazy = true
|
||||
lightbox = true
|
||||
shadow = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter for example by
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
[imageEffects]
|
||||
lazy = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
Or by explicitly override settings by URL query parameter
|
||||
|
||||
````md {title="URL"}
|
||||

|
||||
````
|
||||
|
||||
The settings applied to the above image would be
|
||||
|
||||
{{< multiconfig >}}
|
||||
border = true
|
||||
dataurl = false
|
||||
inlinecontent = false
|
||||
lazy = true
|
||||
lightbox = false
|
||||
shadow = false
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["explanation"]
|
||||
description = "How to apply effects to your images"
|
||||
frontmatter = ["imageEffects"]
|
||||
title = "Image Effects"
|
||||
weight = 6
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,54 @@
|
||||
+++
|
||||
categories = ["explanation"]
|
||||
description = "How to apply graphical effects to your links"
|
||||
frontmatter = ["linkEffects"]
|
||||
title = "Link Effects"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
The theme offers [effects](authoring/markdown#link-effects) for your linked links.
|
||||
|
||||
You can [define additional custom link effects and set defaults](configuration/customization/linkeffects) in your configuration.
|
||||
|
||||
The default link effects shipped with the theme are
|
||||
|
||||
| Name | Description |
|
||||
| -------- | ---------------------------------------------------------------------------- |
|
||||
| download | Causes the linked resource to be downloaded instead of shown in your browser.<br><br>- `false`: a usual link sending you to the location in your browser<br>- `true`: a link to download the resource<br>- _<string>_: a link to download the resource with the given filename |
|
||||
| target | Whether to show the link in a separate browser tab.<br><br>- `false`: shown in the same tab<br>- _<string>_: [a valid `a` `target` value](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target)<br><br>If [`externalLinkTarget` is configured](authoring/frontmatter/linking#opening-links) and the URL is external, this will overwrite the link effect value of your `hugo.toml` and page's front matter but can still be overwritten in the URL query parameter. |
|
||||
|
||||
One way to use them is to add them as URL query parameter to each individual link.
|
||||
|
||||
This can become cumbersome to be done consistently for the whole site. Instead, you can [configure the defaults](configuration/customization/linkeffects) in your `hugo.toml` as well as overriding these defaults in a page's front matter.
|
||||
|
||||
Explicitly set URL query parameter will override the defaults set for a page or your site.
|
||||
|
||||
If an effect accepts boolean values, only setting the parameter name without a value in the URL will set it to `true`.
|
||||
|
||||
Without any settings in your `hugo.toml` `linkEffects` defaults to
|
||||
|
||||
{{< multiconfig >}}
|
||||
[linkEffects]
|
||||
download = false
|
||||
target = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter for example by
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
[linkEffects]
|
||||
target = '_blank'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
Or by explicitly override settings by URL query parameter
|
||||
|
||||
````md {title="URL"}
|
||||
[Magic in new window](images/magic.gif?target=_self)
|
||||
````
|
||||
|
||||
The settings applied to the above link would be
|
||||
|
||||
{{< multiconfig >}}
|
||||
download = false
|
||||
target = '_self'
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["explanation"]
|
||||
description = "How to apply graphical effects to your links"
|
||||
frontmatter = ["linkEffects"]
|
||||
title = "Link Effects"
|
||||
weight = 5
|
||||
+++
|
||||
{{< piratify >}}
|
||||
877
themes/hugo-theme-relearn/docs/content/authoring/markdown.en.md
Normal file
877
themes/hugo-theme-relearn/docs/content/authoring/markdown.en.md
Normal file
@@ -0,0 +1,877 @@
|
||||
+++
|
||||
description = "Reference of CommonMark and Markdown extensions"
|
||||
categories = ["howto", "reference"]
|
||||
title = "Markdown Syntax"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
Let's face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
||||
|
||||
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
||||
|
||||
Some of the key benefits are:
|
||||
|
||||
1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content.
|
||||
2. Less chance of errors when writing in Markdown.
|
||||
3. Produces valid HTML output.
|
||||
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
|
||||
5. Write in any text editor or Markdown application you like.
|
||||
6. Markdown is a joy to use!
|
||||
|
||||
John Gruber, the author of Markdown, puts it like this:
|
||||
|
||||
> The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. While Markdown's syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown's syntax is the format of plain text email.
|
||||
> <cite>John Gruber</cite>
|
||||
|
||||
{{% notice tip %}}
|
||||
{{% icon bookmark %}} Bookmark this page for easy future reference!
|
||||
{{% /notice %}}
|
||||
|
||||
## Standard and Extensions
|
||||
|
||||
If not otherwise noted, the shown examples adhere to the [CommonMark](https://commonmark.org/help/) standard. In addition the theme supports the following extensions that [can be activated](https://gohugo.io/getting-started/configuration-markup/#goldmark) in your `hugo.toml` or are built into the theme:
|
||||
|
||||
- {{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} Extension on top of standard Markdown adhering to [GitHub Flavored Markdown](https://github.github.com/gfm/).
|
||||
|
||||
- {{% badge color="#888cc4" icon="fa-fw fab fa-php" %}}PHP{{% /badge %}} Extension on top of standard Markdown adhering to [PHP Markdown](https://michelf.ca/projects/php-markdown/extra/).
|
||||
|
||||
- {{% badge color="darkorange" icon="lightbulb" %}}Pants{{% /badge %}} Extension by John Gruber adhering to [SmartyPants](https://daringfireball.net/projects/smartypants/).
|
||||
|
||||
- {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" %}}Hugo{{% /badge %}} [Hugo Extra Extension](https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension) supported by Hugo.
|
||||
|
||||
- {{% badge color="#7c3aed" icon="fa-fw far fa-gem" %}}Obsidian{{% /badge %}} Extension implemented by [Obsidian](https://obsidian.md/).
|
||||
|
||||
- {{% badge color="orangered" icon="fa-fw fas fa-code" %}}HTML{{% /badge %}} If the [usage of HTML](https://gohugo.io/getting-started/configuration-markup/#rendererunsafe) is allowed, the theme supports styling for further HTML elements.
|
||||
|
||||
- {{% badge color="#7dc903" icon="fa-fw fas fa-puzzle-piece" %}}Relearn{{% /badge %}} Extension specific to this theme.
|
||||
|
||||
## Paragraphs
|
||||
|
||||
In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.
|
||||
|
||||
Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.
|
||||
|
||||
````md
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
{{% /notice %}}
|
||||
|
||||
## Headings
|
||||
|
||||
A good idea is to structure your content using headings and subheadings. HTML-headings from `h1` through `h6` are constructed with a `#` for each level.
|
||||
|
||||
In Hugo you usually don't use `h1` as this is generated by your theme and you should only have one such element in a document.
|
||||
|
||||
````md
|
||||
# h1 Heading
|
||||
|
||||
## h2 Heading
|
||||
|
||||
### h3 Heading
|
||||
|
||||
#### h4 Heading
|
||||
|
||||
##### h5 Heading
|
||||
|
||||
###### h6 Heading
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
|
||||
# h1 Heading
|
||||
|
||||
## h2 Heading
|
||||
|
||||
### h3 Heading
|
||||
|
||||
#### h4 Heading
|
||||
|
||||
##### h5 Heading
|
||||
|
||||
###### h6 Heading
|
||||
{{% /notice %}}
|
||||
|
||||
## Horizontal Rules
|
||||
|
||||
To further structure your content you can add horizontal rules. They create a "thematic break" between paragraph blocks. In Markdown, you can create it with three consecutive dashes `---`.
|
||||
|
||||
````md
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
---
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
---
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
{{% /notice %}}
|
||||
|
||||
## Blockquotes
|
||||
|
||||
### Quotations
|
||||
|
||||
For quoting blocks of content from another source within your document add `>` before any text you want to quote.
|
||||
|
||||
Blockquotes can also be nested.
|
||||
|
||||
````md
|
||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.
|
||||
>
|
||||
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||||
>
|
||||
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.
|
||||
>
|
||||
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||||
>
|
||||
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
||||
{{% /notice %}}
|
||||
|
||||
### GitHub Alerts
|
||||
|
||||
{{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} Since Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" %}}0.132.0{{% /badge %}} [GitHub alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) are also supported. Please note, that coloring and icons of severities may defer between GitHub and this theme.
|
||||
|
||||
If you are in need of more advanced options to style your alerts, like icons, use the [notice shortcode](shortcodes/notice).
|
||||
|
||||
````md
|
||||
> [!CAUTION]
|
||||
> Advises about risks or negative outcomes of certain actions.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Key information users need to know to achieve their goal.
|
||||
|
||||
> [!INFO]
|
||||
> Information that users <ins>_might_</ins> find interesting.
|
||||
|
||||
> [!NOTE]
|
||||
> Useful information that users should know, even when skimming content.
|
||||
|
||||
> [!TIP]
|
||||
> Helpful advice for doing things better or more easily.
|
||||
|
||||
> [!WARNING]
|
||||
> Urgent info that needs immediate user attention to avoid problems.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
> [!CAUTION]
|
||||
> Advises about risks or negative outcomes of certain actions.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Key information users need to know to achieve their goal.
|
||||
|
||||
> [!INFO]
|
||||
> Information that users <ins>_might_</ins> find interesting.
|
||||
|
||||
> [!NOTE]
|
||||
> Useful information that users should know, even when skimming content.
|
||||
|
||||
> [!TIP]
|
||||
> Helpful advice for doing things better or more easily.
|
||||
|
||||
> [!WARNING]
|
||||
> Urgent info that needs immediate user attention to avoid problems.
|
||||
{{% /notice %}}
|
||||
|
||||
### Obsidian Callouts
|
||||
|
||||
{{% badge color="#7c3aed" icon="fa-fw far fa-gem" %}}Obsidian{{% /badge %}} Since Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" %}}0.134.0{{% /badge %}} [Obsidian callouts](https://help.obsidian.md/Editing+and+formatting/Callouts#Change+the+title) are also supported. Which enables configurable title text and expand/collapse.
|
||||
|
||||
If you are in need of more advanced options to style your alerts, like icons, use the [notice shortcode](shortcodes/notice).
|
||||
|
||||
````md
|
||||
> [!tip] Callouts can have custom titles
|
||||
> Like this one.
|
||||
|
||||
> [!tip] Title-only callout
|
||||
|
||||
> [!note]- Are callouts foldable?
|
||||
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed
|
||||
|
||||
> [!note]+ Are callouts foldable?
|
||||
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
> [!tip] Callouts can have custom titles
|
||||
> Like this one.
|
||||
|
||||
> [!tip] Title-only callout
|
||||
|
||||
> [!note]- Are callouts foldable?
|
||||
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed
|
||||
|
||||
> [!note]+ Are callouts foldable?
|
||||
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed
|
||||
{{% /notice %}}
|
||||
|
||||
## Text Markers
|
||||
|
||||
### Bold
|
||||
|
||||
You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks `**`.
|
||||
|
||||
````md
|
||||
I am rendered with **bold text**
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
I am rendered with **bold text**
|
||||
{{% /notice %}}
|
||||
|
||||
### Italics
|
||||
|
||||
You can emphasize a snippet of text with italics by enclosing it with underscores `_`.
|
||||
|
||||
````md
|
||||
I am rendered with _italicized text_
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
I am rendered with _italicized text_
|
||||
{{% /notice %}}
|
||||
|
||||
### Marked Text
|
||||
|
||||
You can mark text in the predefined accent color of your stylesheet.
|
||||
|
||||
{{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" %}}Hugo{{% /badge %}} Since Hugo 0.126.0, you can [activate this through the _Hugo Extra Extension_](https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension) in your `hugo.toml`
|
||||
|
||||
````md
|
||||
==Parts== of this text ==are marked!==
|
||||
````
|
||||
|
||||
{{% badge color="orangered" icon="fa-fw fas fa-code" %}}HTML{{% /badge %}} You can also use it by configuring Hugo for [usage of HTML](https://gohugo.io/getting-started/configuration-markup/#rendererunsafe).
|
||||
|
||||
````html
|
||||
<mark>Parts</mark> of this text <mark>are marked!</mark>
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
<mark>Parts</mark> of this text <mark>are marked!</mark>
|
||||
{{% /notice %}}
|
||||
|
||||
### Inserted Text
|
||||
|
||||
You can mark text additions to existing text.
|
||||
|
||||
{{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" %}}Hugo{{% /badge %}} Since Hugo 0.126.0, you can [activate this through the _Hugo Extra Extension_](https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension) in your `hugo.toml`
|
||||
|
||||
````md
|
||||
The ++hot, new++ stuff
|
||||
````
|
||||
|
||||
{{% badge color="orangered" icon="fa-fw fas fa-code" %}}HTML{{% /badge %}} You can also use it by configuring Hugo for [usage of HTML](https://gohugo.io/getting-started/configuration-markup/#rendererunsafe).
|
||||
|
||||
````html
|
||||
The <ins>hot, new</ins> stuff
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
The ++hot, new++ stuff
|
||||
{{% /notice %}}
|
||||
|
||||
### Deleted Text
|
||||
|
||||
{{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} You can do strikethroughs by enclosing text with two tildes `~~`. See [Hugo's documentation remarks](https://gohugo.io/getting-started/configuration-markup/#extras) if you want to use this together with the subscript syntax.
|
||||
|
||||
````md
|
||||
~~Strike through~~ this text
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
~~Strike through~~ this text
|
||||
{{% /notice %}}
|
||||
|
||||
## Special Typesetting
|
||||
|
||||
### Text Substitution
|
||||
|
||||
{{% badge color="darkorange" icon="lightbulb" %}}Pants{{% /badge %}} You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.
|
||||
|
||||
````md
|
||||
Double quotes `"` and single quotes `'` of enclosed text are replaced by **"double curly quotes"** and **'single curly quotes'**.
|
||||
|
||||
Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities.
|
||||
|
||||
Double arrows pointing left `<<` or right `>>` are replaced by arrow **<<** and **>>** entities.
|
||||
|
||||
Three consecutive dots `...` are replaced by an ellipsis **...** entity.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
Double quotes `"` and single quotes `'` of enclosed text are replaced by **"double curly quotes"** and **'single curly quotes'**.
|
||||
|
||||
Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities.
|
||||
|
||||
Double arrows pointing left `<<` or right `>>` are replaced by arrow **<<** and **>>** entities.
|
||||
|
||||
Three consecutive dots `...` are replaced by an ellipsis **...** entity.
|
||||
{{% /notice %}}
|
||||
|
||||
### Subscript and Superscript
|
||||
|
||||
You can also use subscript and superscript text. For more complex stuff, you can use the [`math` shortcode](shortcodes/math).
|
||||
|
||||
{{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" %}}Hugo{{% /badge %}} Since Hugo 0.126.0, you can [activate this through the _Hugo Extra Extension_](https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension) in your `hugo.toml`
|
||||
|
||||
````md
|
||||
How many liters H~2~O fit into 1dm^3^?
|
||||
````
|
||||
|
||||
{{% badge color="orangered" icon="fa-fw fas fa-code" %}}HTML{{% /badge %}} You can also use it by configuring Hugo for [usage of HTML](https://gohugo.io/getting-started/configuration-markup/#rendererunsafe).
|
||||
|
||||
````html
|
||||
How many liters H<sub>2</sub>O fit into 1dm<sup>3</sup>?
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
How many liters H~2~O fit into 1dm^3^?
|
||||
{{% /notice %}}
|
||||
|
||||
### Keyboard Shortcuts
|
||||
|
||||
{{% badge color="orangered" icon="fa-fw fas fa-code" %}}HTML{{% /badge %}} You can use the `<kbd>` element to style keyboard shortcuts.
|
||||
|
||||
````html
|
||||
Press <kbd>STRG</kbd> <kbd>ALT</kbd> <kbd>DEL</kbd> to end your shift early.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
Press <kbd>STRG</kbd> <kbd>ALT</kbd> <kbd>DEL</kbd> to end your shift early.
|
||||
{{% /notice %}}
|
||||
|
||||
## Lists
|
||||
|
||||
### Unordered
|
||||
|
||||
You can write a list of items in which the order of the items does not explicitly matter.
|
||||
|
||||
It is possible to nest lists by indenting an item for the next sublevel.
|
||||
|
||||
You may use any of `-`, `*` or `+` to denote bullets for each list item but should not switch between those symbols inside one whole list.
|
||||
|
||||
````md
|
||||
- Lorem ipsum dolor sit amet
|
||||
- Consectetur adipiscing elit
|
||||
- Vestibulum laoreet porttitor sem
|
||||
- Ac tristique libero volutpat at
|
||||
- Nulla volutpat aliquam velit
|
||||
- Phasellus iaculis neque
|
||||
- Purus sodales ultricies
|
||||
- Faucibus porta lacus fringilla vel
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
- Lorem ipsum dolor sit amet
|
||||
- Consectetur adipiscing elit
|
||||
- Vestibulum laoreet porttitor sem
|
||||
- Ac tristique libero volutpat at
|
||||
- Nulla volutpat aliquam velit
|
||||
- Phasellus iaculis neque
|
||||
- Purus sodales ultricies
|
||||
- Faucibus porta lacus fringilla vel
|
||||
{{% /notice %}}
|
||||
|
||||
### Ordered
|
||||
|
||||
You can create a list of items in which the order of items does explicitly matter.
|
||||
|
||||
It is possible to nest lists by indenting an item for the next sublevel.
|
||||
|
||||
Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.
|
||||
|
||||
````md
|
||||
1. Lorem ipsum dolor sit amet
|
||||
3. Consectetur adipiscing elit
|
||||
1. Integer molestie lorem at massa
|
||||
7. Facilisis in pretium nisl aliquet
|
||||
99. Nulla volutpat aliquam velit
|
||||
1. Faucibus porta lacus fringilla vel
|
||||
1. Aenean sit amet erat nunc
|
||||
17. Eget porttitor lorem
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
1. Lorem ipsum dolor sit amet
|
||||
1. Consectetur adipiscing elit
|
||||
1. Integer molestie lorem at massa
|
||||
7. Facilisis in pretium nisl aliquet
|
||||
99. Nulla volutpat aliquam velit
|
||||
1. Faucibus porta lacus fringilla vel
|
||||
1. Aenean sit amet erat nunc
|
||||
17. Eget porttitor lorem
|
||||
{{% /notice %}}
|
||||
|
||||
### Tasks
|
||||
|
||||
{{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} You can add task lists resulting in checked or unchecked non-clickable items
|
||||
|
||||
````md
|
||||
- [x] Basic Test
|
||||
- [ ] More Tests
|
||||
- [x] View
|
||||
- [x] Hear
|
||||
- [ ] Smell
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
- [x] Basic Test
|
||||
- [ ] More Tests
|
||||
- [x] View
|
||||
- [x] Hear
|
||||
- [ ] Smell
|
||||
{{% /notice %}}
|
||||
|
||||
### Definitions
|
||||
|
||||
{{% badge color="#888cc4" icon="fa-fw fab fa-php" %}}PHP{{% /badge %}} Definition lists are made of terms and definitions of these terms, much like in a dictionary.
|
||||
|
||||
A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.
|
||||
|
||||
If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible
|
||||
|
||||
````md
|
||||
Apple
|
||||
: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
|
||||
: An American computer company.
|
||||
|
||||
Orange
|
||||
: The fruit of an evergreen tree of the genus Citrus.
|
||||
|
||||
You can make juice out of it.
|
||||
: A telecommunication company.
|
||||
|
||||
You can't make juice out of it.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
Apple
|
||||
: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
|
||||
: An American computer company.
|
||||
|
||||
Orange
|
||||
: The fruit of an evergreen tree of the genus Citrus.
|
||||
|
||||
You can make juice out of it.
|
||||
: A telecommunication company.
|
||||
|
||||
You can't make juice out of it.
|
||||
{{% /notice %}}
|
||||
|
||||
## Code
|
||||
|
||||
### Inline Code
|
||||
|
||||
Inline snippets of code can be wrapped with backticks `` ` ``.
|
||||
|
||||
````md
|
||||
In this example, `<div></div>` is marked as code.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
In this example, `<div></div>` is marked as code.
|
||||
{{% /notice %}}
|
||||
|
||||
### Indented Code Block
|
||||
|
||||
A simple code block can be generated by indenting several lines of code by at least two spaces.
|
||||
|
||||
````md
|
||||
Be impressed by my advanced code:
|
||||
|
||||
// Some comments
|
||||
line 1 of code
|
||||
line 2 of code
|
||||
line 3 of code
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
Be impressed by my advanced code:
|
||||
|
||||
// Some comments
|
||||
line 1 of code
|
||||
line 2 of code
|
||||
line 3 of code
|
||||
{{% /notice %}}
|
||||
|
||||
### Fenced Code Block
|
||||
|
||||
If you want to gain more control of your code block you can enclose your code by at least three backticks ```` ``` ```` a so called fence.
|
||||
|
||||
{{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} You can also add a language specifier directly after the opening fence, ` ```js `, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.
|
||||
|
||||
See [Code Highlighting](shortcodes/highlight) for additional documentation.
|
||||
|
||||
````plaintext
|
||||
```js
|
||||
{
|
||||
name: "Claus",
|
||||
surname: "Santa",
|
||||
profession: "courier",
|
||||
age: 666,
|
||||
address: {
|
||||
city: "North Pole",
|
||||
postalCode: 1,
|
||||
country: "Arctic"
|
||||
},
|
||||
friends: [ "Dasher", "Dancer", "Prancer", "Vixen", "Comet", "Cupid", "Donder", "Blitzen", "Rudolph" ]
|
||||
};
|
||||
```
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
```js
|
||||
{
|
||||
name: "Claus",
|
||||
surname: "Santa",
|
||||
profession: "courier",
|
||||
age: 666,
|
||||
address: {
|
||||
city: "North Pole",
|
||||
postalCode: 1,
|
||||
country: "Arctic"
|
||||
},
|
||||
friends: [ "Dasher", "Dancer", "Prancer", "Vixen", "Comet", "Cupid", "Donder", "Blitzen", "Rudolph" ]
|
||||
};
|
||||
```
|
||||
{{% /notice %}}
|
||||
|
||||
## Tables
|
||||
|
||||
{{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} You can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
|
||||
|
||||
````md
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| data | path to data files to supply the data that will be passed into templates. |
|
||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
||||
| ext | extension to be used for dest files. |
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| data | path to data files to supply the data that will be passed into templates. |
|
||||
| engine | engine to be used for processing templates. Handlebars is the default. |
|
||||
| ext | extension to be used for dest files. |
|
||||
{{% /notice %}}
|
||||
|
||||
### Aligned Columns
|
||||
|
||||
Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.
|
||||
|
||||
````md
|
||||
| Option | Number | Description |
|
||||
|-------:|:------:|:------------|
|
||||
| data | 1 | path to data files to supply the data that will be passed into templates. |
|
||||
| engine | 2 | engine to be used for processing templates. Handlebars is the default. |
|
||||
| ext | 3 | extension to be used for dest files. |
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
| Option | Number | Description |
|
||||
|-------:|:------:|:------------|
|
||||
| data | 1 | path to data files to supply the data that will be passed into templates. |
|
||||
| engine | 2 | engine to be used for processing templates. Handlebars is the default. |
|
||||
| ext | 3 | extension to be used for dest files. |
|
||||
{{% /notice %}}
|
||||
|
||||
## Links
|
||||
|
||||
### Autolink
|
||||
|
||||
{{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} Absolute URLs will automatically be converted into a link.
|
||||
|
||||
````md
|
||||
This is a link to https://example.com.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
This is a link to https://example.com.
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
### Basic Link
|
||||
|
||||
You can explicitly define links in case you want to use non-absolute URLs or want to give different text.
|
||||
|
||||
````md
|
||||
[Assemble](http://assemble.io)
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
[Assemble](http://assemble.io)
|
||||
{{% /notice %}}
|
||||
|
||||
### Link with Tooltip
|
||||
|
||||
For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.
|
||||
|
||||
````md
|
||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
||||
{{% /notice %}}
|
||||
|
||||
### Link References
|
||||
|
||||
Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.
|
||||
|
||||
````md
|
||||
[Example][somelinkID]
|
||||
|
||||
[somelinkID]: https://example.com "Go to example domain"
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
[Example][somelinkID]
|
||||
|
||||
[somelinkID]: https://example.com "Go to example domain"
|
||||
{{% /notice %}}
|
||||
|
||||
### Footnotes
|
||||
|
||||
{{% badge color="#888cc4" icon="fa-fw fab fa-php" %}}PHP{{% /badge %}} Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.
|
||||
|
||||
Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.
|
||||
|
||||
Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.
|
||||
|
||||
````md
|
||||
That's some text with a footnote[^1]
|
||||
|
||||
[^1]: And that's the footnote.
|
||||
|
||||
That's some more text with a footnote.[^someid]
|
||||
|
||||
[^someid]:
|
||||
Anything of interest goes here.
|
||||
|
||||
Blue light glows blue.
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
That's some text with a footnote[^1]
|
||||
|
||||
[^1]: And that's the footnote.
|
||||
|
||||
That's some more text with a footnote.[^someid]
|
||||
|
||||
[^someid]:
|
||||
Anything of interest goes here.
|
||||
|
||||
Blue light glows blue.
|
||||
{{% /notice %}}
|
||||
|
||||
### Link Effects
|
||||
|
||||
{{% badge color="#7dc903" icon="fa-fw fas fa-puzzle-piece" %}}Relearn{{% /badge %}} This theme allows additional non-standard formatting by setting query parameter at the end of the URL. See the [link effects docs](authoring/linkeffects) for a detailed example and how to configure it.
|
||||
|
||||
#### Target
|
||||
|
||||
Add query parameter `target=_self` or `target=_blank` to override [site-wide settings](authoring/frontmatter/linking#opening-links) of [the target behavior](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target) individuallly for each link.
|
||||
|
||||
````md
|
||||
[Magic in new window](images/magic.gif?target=_blank)
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
[Magic in new window](images/magic.gif?target=_blank)
|
||||
{{% /notice %}}
|
||||
|
||||
#### Download
|
||||
|
||||
Add query parameter `download` or `download=myfile.gif` to force your browser [to download the link target](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) instead of opening it.
|
||||
|
||||
````md
|
||||
[Magic as a download](images/magic.gif?download)
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
[Magic as a download](images/magic.gif?download)
|
||||
{{% /notice %}}
|
||||
|
||||
## Images
|
||||
|
||||
### Basic Images
|
||||
|
||||
Images have a similar syntax to links but include a preceding exclamation mark.
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
### Image with Tooltip
|
||||
|
||||
Like links, images can also be given a tooltip.
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
### Image References
|
||||
|
||||
Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.
|
||||
|
||||
````md
|
||||
![La Forge][laforge]
|
||||
|
||||
[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"
|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||
![La Forge][laforge]
|
||||
|
||||
[laforge]: https://octodex.github.com/images/trekkie.jpg?width=20vw "Geordi La Forge"
|
||||
{{% /notice %}}
|
||||
|
||||
### Image Effects
|
||||
|
||||
{{% badge color="#7dc903" icon="fa-fw fas fa-puzzle-piece" %}}Relearn{{% /badge %}} This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. See the [image effects docs](authoring/imageeffects) for a detailed example and how to configure it.
|
||||
|
||||
#### Resizing
|
||||
|
||||
Add query parameter `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
#### CSS Classes
|
||||
|
||||
Add a query parameter `classes` to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.
|
||||
|
||||
##### Shadow
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
##### Border
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
##### Left
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
##### Right
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
##### Inline
|
||||
|
||||
````md
|
||||

|
||||

|
||||

|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||

|
||||

|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
##### Combination
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
#### Lightbox
|
||||
|
||||
Add the query parameter `lightbox=false` to the image link to disable the lightbox.
|
||||
|
||||
````md
|
||||

|
||||
````
|
||||
|
||||
{{% notice style="code" icon="eye" title="Result" %}}
|
||||

|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice note %}}
|
||||
If you want to wrap an image in a link and `lightbox=true` is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:
|
||||
|
||||
````md
|
||||
[](https://octodex.github.com/#homercat)
|
||||
````
|
||||
|
||||
[](https://octodex.github.com/#homercat)
|
||||
|
||||
{{% /notice %}}
|
||||
@@ -0,0 +1,7 @@
|
||||
+++
|
||||
description = "Reference of CommonMark and Markdown extensions"
|
||||
categories = ["howto", "reference"]
|
||||
title = "Marrrkdown Rules"
|
||||
weight = 4
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,71 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "What page meta information are available"
|
||||
frontmatter = ["headingPost", "headingPre", "hidden", "LastModifierDisplayName", "LastModifierEmail"]
|
||||
title = "Meta Information"
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
## Page Title
|
||||
|
||||
The `title` will be used in the heading and meta information of your HTML.
|
||||
|
||||
A page without a title is [treated as if `hidden=true`](#hidden) has been set.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
title = 'Example Title'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Page Description
|
||||
|
||||
The `description` is used for generating HTML meta information, in the [children](shortcodes/children) shortcode and in social media meta information.
|
||||
|
||||
If not set, the set value of your site's hugo.toml is used for the HTML meta information and social media meta information. It appears empty for the [children](shortcodes/children) shortcode.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
description = 'Some lenghty example description'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Social Media Images
|
||||
|
||||
The theme adds social media meta tags including feature images for the [Open Graph](https://gohugo.io/templates/internal/#open-graph) protocol and [Twitter Cards](https://gohugo.io/templates/internal/#twitter-cards) to your site. These are configured as mentioned in the linked Hugo docs.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
images = [ 'images/hero.png' ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Hidden
|
||||
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide your pages from the menu by setting `hidden=true`.
|
||||
|
||||
{{% badge color="blueviolet" icon="bars" title=" " %}}Menu{{% /badge %}} For [Hugo menus](https://gohugo.io/content-management/menus/), you have to set `params.hidden=true` instead.
|
||||
|
||||
[See how you can further configure visibility](configuration/content/hidden) throughout your site.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
hidden = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Add Icon to the Title Heading
|
||||
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} In the page front matter, add a `headingPre` to insert any HTML code before the title heading. You can also set `headingPost` to insert HTML code after the title heading.
|
||||
|
||||
You also may want to [apply further CSS](configuration/customization/extending#adding-javascript-or-stylesheets-to-all-pages) in this case.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
headingPre = '<i class="fab fa-github"></i> '
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Footer Information
|
||||
|
||||
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} If you use the default `layouts/partials/content-footer.html` is not overridden by you, it will display authoring information, namely
|
||||
|
||||
- `AuthorName` if [GitInfo](https://gohugo.io/methods/page/gitinfo/) is active, otherwise `LastModifierDisplayName` front matter
|
||||
- `AuthorEmail` if [GitInfo](https://gohugo.io/methods/page/gitinfo/) is active, otherwise `LastModifierEmail` front matter
|
||||
- `AuthorDate` if [GitInfo](https://gohugo.io/methods/page/gitinfo/) is active, otherwise [Hugo's `date` front matter](https://gohugo.io/methods/page/date/)
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
LastModifierDisplayName = 'Santa Claus'
|
||||
LastModifierEmail = 'santa@example.com'
|
||||
date = 2000-12-24T00:00:00-12:00
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "What page meta information are available"
|
||||
frontmatter = ["headingPost", "headingPre", "hidden", "LastModifierDisplayName", "LastModifierEmail"]
|
||||
title = "Meta Information"
|
||||
weight = 3
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,35 @@
|
||||
+++
|
||||
categories = ["explanation"]
|
||||
description = "Your content's directory structure"
|
||||
title = "Directory Structure"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
In **Hugo**, pages are the core of your site.
|
||||
|
||||
The theme generates the navigation menu out of the given directory structure.
|
||||
|
||||
Organize your site like [any other Hugo project](https://gohugo.io/content/structure/). Typically, you will have a _content_ directory with all your pages.
|
||||
|
||||
````plaintext
|
||||
content
|
||||
├── log
|
||||
│ ├── first-day
|
||||
| | |── _index.md
|
||||
| │ ├── first-sub-page
|
||||
| | | |── _index.md
|
||||
| | | |── picture1.png
|
||||
| | | └── plain.txt
|
||||
│ ├── second-day
|
||||
| | |── index.md
|
||||
| | |── picture1.png
|
||||
| | └── picture2.png
|
||||
│ ├── third-day.md
|
||||
│ └── _index.md
|
||||
└── _index.md
|
||||
````
|
||||
|
||||
> [!note]
|
||||
> While you can also go different, `_index.md` (with an underscore) is recommended for each directory, it's your _directory's home page_.
|
||||
>
|
||||
> See [Hugo's guide for content ](https://gohugo.io/content-management/) to learn more.
|
||||
@@ -0,0 +1,7 @@
|
||||
+++
|
||||
categories = ["explanation"]
|
||||
description = "Your content's directory structure"
|
||||
title = "Directory Structure"
|
||||
weight = 1
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,11 @@
|
||||
+++
|
||||
categories = ["reference"]
|
||||
menuPre = "<i class='fa-fw fas fa-gears'></i> "
|
||||
title = "Configuration"
|
||||
type = "chapter"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
Find out how to configure and customize your site.
|
||||
|
||||
{{% children containerstyle="div" style="h2" description=true %}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["reference"]
|
||||
menuPre = "<i class='fa-fw fas fa-gears'></i> "
|
||||
title = "Configurrrat'n"
|
||||
type = "chapter"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,9 @@
|
||||
+++
|
||||
alwaysopen = false
|
||||
categories = ["reference"]
|
||||
description = "Change colors and logos of your site"
|
||||
title = "Branding"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
{{% children containerstyle="div" style="h2" description=true %}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
alwaysopen = false
|
||||
categories = ["reference"]
|
||||
description = "Change colors and logos of your site"
|
||||
title = "Brrrand'n"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,180 @@
|
||||
+++
|
||||
categories = ["explanation", "howto"]
|
||||
description = "Learn how to customize your site's colors"
|
||||
options = ["themeVariant"]
|
||||
title = "Colors"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
The Relearn theme offers color variants to change your site's appearance. Each color variant contains of a CSS file and optional settings in your `hugo.toml`.
|
||||
|
||||
You can use the [shipped variants](#shipped-variants), [customize them](#modifying-variants), or create your own. The [interactive variant generator](configuration/branding/generator) can help you with this.
|
||||
|
||||
Once set up in `hugo.toml`, you can switch variants using the selector at the bottom of the menu.
|
||||
|
||||
## Shipped Variants
|
||||
|
||||
The theme ships with the following set of variants
|
||||
|
||||
- Relearn
|
||||
- Light: the classic Relearn default, coming with signature green, dark sidebar and light content area
|
||||
- Dark: dark variant of Light, coming with signature green, dark sidebar and dark content area
|
||||
- Bright: alternative of Light, coming with signature green, green sidebar and light content area
|
||||
- Zen
|
||||
- Light: a more relaxed white/grey variant, coming with blue accents, light sidebar and light content area
|
||||
- Dark: dark variant of Light, coming with blue accents, dark sidebar and dark content area
|
||||
- Experimental
|
||||
- Neon: a variant that glows in the dark, gradient sidebar and dark content area
|
||||
- Retro
|
||||
- Learn: the default of the old Learn theme, coming with signature light purple, dark sidebar and light content area
|
||||
- Blue: a blue variant of the old Learn theme, coming tinted in blue, dark sidebar and light content area
|
||||
- Green: a green variant of the old Learn theme, coming tinted in green, dark sidebar and light content area
|
||||
- Red: a red variant of the old Learn theme, coming tinted in red, dark sidebar and light content area
|
||||
|
||||
## Changing the Variant
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set the `themeVariant` option to change the variant.
|
||||
|
||||
The theme offers the recommended [advanced configuration mode](#theme-variant-advanced) that combines the functionality for [multiple variants](#multiple-variants), [OS setting adjustments](#adjust-to-os-settings), and more.
|
||||
|
||||
### Simple Setup {#theme-variant}
|
||||
|
||||
#### Single Variant
|
||||
|
||||
Set `themeVariant` to your theme CSS file name:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariant = 'relearn-light'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
Place your theme file in `assets/css` or `themes/hugo-theme-relearn/assets/css`. Name it `theme-*.css`.
|
||||
|
||||
In the above example, the path of your theme file must be `assets/css/theme-relearn-light.css` or `themes/hugo-theme-relearn/assets/css/theme-relearn-light.css`.
|
||||
|
||||
#### Multiple Variants
|
||||
|
||||
To let the reader choose between multiple variants, set `themeVariant` like this:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariant = [ 'relearn-light', 'relearn-dark' ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
The first variant is the default, and a selector will appear if there's more than one.
|
||||
|
||||
#### Adjust to OS Settings
|
||||
|
||||
Use the `auto` value to match OS light/dark settings. Usually it makes sense to set it in the first position and make it the default.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariant = [ 'auto', 'red' ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
If you don't configure anything else, the theme will default to use `relearn-light` for light mode and `relearn-dark` for dark mode.
|
||||
|
||||
Default is `relearn-light` for light and `relearn-dark` for dark mode. These defaults are overwritten by the first two non-auto options of your `themeVariant` array.
|
||||
|
||||
You can override the default with `themeVariantAuto`:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariantAuto = [ 'learn', 'neon' ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
### Advanced {#theme-variant-advanced}
|
||||
|
||||
The theme offers an advanced way to configure theme variants and all of the aspects above inside of a single configuration item. This comes with some features previously unsupported.
|
||||
|
||||
Like with the [multiple variants](#multiple-variants) option, you are defining your theme variants in an array but now in a table with suboptions.
|
||||
|
||||
Again, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariant = [ 'relearn-light', 'relearn-dark' ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
you now write it that way:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
[[params.themeVariant]]
|
||||
identifier = 'relearn-light'
|
||||
[[params.themeVariant]]
|
||||
identifier = 'relearn-dark'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
The `identifier` option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.
|
||||
|
||||
#### Parameter
|
||||
|
||||
| Name | Default | Notes |
|
||||
|-----------------------|-----------------|-------------|
|
||||
| identifier | _<empty>_ | Must correspond to the name of a color variant either in your site's or the theme's directory in the form `assets/css/theme-<IDENTIFIER>.css`. |
|
||||
| name | see notes | The name to be displayed in the variant selector. If not set, the identifier is used in a human readable form. |
|
||||
| auto | _<empty>_ | If set, the variant is treated as an [auto mode variant](#adjust-to-os-settings). It has the same behavior as the `themeVariantAuto` option. The first entry in the array is the color variant for light mode, the second for dark mode. Defining auto mode variants with the advanced options has the benefit that you can now have multiple auto mode variants instead of just one with the simple options. |
|
||||
|
||||
#### Example Configuration
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariant = [
|
||||
{ identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] },
|
||||
{ identifier = 'relearn-light' },
|
||||
{ identifier = 'relearn-dark' },
|
||||
{ identifier = 'relearn-bright' },
|
||||
{ identifier = 'zen-auto', name = 'Zen Light/Dark', auto = [ 'zen-light', 'zen-dark' ] },
|
||||
{ identifier = 'zen-light' },
|
||||
{ identifier = 'zen-dark' },
|
||||
{ identifier = 'retro-auto', name = 'Retro Learn/Neon', auto = [ 'learn', 'neon' ] },
|
||||
{ identifier = 'neon' },
|
||||
{ identifier = 'learn' }
|
||||
]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Advanced Topics
|
||||
|
||||
### Modifying Variants
|
||||
|
||||
In case you like a shipped variant but only want to tweak some aspects, you have some choices. **Don't edit the file in the theme's directory!** You will lose the ability to later easily upgrade your theme to a newer version.
|
||||
|
||||
1. Copy and change
|
||||
|
||||
You can copy the shipped variant file from the theme's `themes/hugo-theme-relearn/assets/css` directory to the site's `assets/css` directory and either store it with the same name or give it a new name. Edit the settings and save the new file. Afterwards, you can use it in your `hugo.toml` by the chosen name.
|
||||
|
||||
2. Create and import
|
||||
|
||||
You can create a new variant file in the site's `assets/css` directory and give it a new name. Import the shipped variant, add the settings you want to change and save the new file. Afterwards, you can use it in your `hugo.toml` by the chosen name.
|
||||
|
||||
For example, you want to use the `relearn-light` variant but want to change the syntax highlighting schema to the one used in the `neon` variant. For that, create a new `assets/css/theme-my-branding.css` in your site's directory and add the following lines:
|
||||
|
||||
````css {title="assets/css/theme-my-branding.css"}
|
||||
@import "theme-relearn-light.css";
|
||||
|
||||
:root {
|
||||
--CODE-theme: neon; /* name of the chroma stylesheet file */
|
||||
--CODE-BLOCK-color: rgba( 226, 228, 229, 1 ); /* fallback color for code text */
|
||||
--CODE-BLOCK-BG-color: rgba( 40, 42, 54, 1 ); /* fallback color for code background */
|
||||
}
|
||||
````
|
||||
|
||||
Afterwards, put this in your `hugo.toml` to use your new variant:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
themeVariant = 'my-branding'
|
||||
{{< /multiconfig >}}
|
||||
|
||||
In comparison to _copy and change_, this has the advantage that you profit from any adjustments to the `relearn-light` variant while keeping your modifications.
|
||||
|
||||
### React to Variant Switches in JavaScript
|
||||
|
||||
Once a color variant is fully loaded, either initially or by switching the color variant manually with the variant selector, the custom event `themeVariantLoaded` on the `document` will be dispatched. You can add an event listener and react to changes.
|
||||
|
||||
````javascript {title="JavaScript"}
|
||||
document.addEventListener( 'themeVariantLoaded', function( e ){
|
||||
console.log( e.detail.variant ); // `relearn-light`
|
||||
});
|
||||
````
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["explanation", "howto"]
|
||||
description = "Learn how to customize your site's colors"
|
||||
options = ["themeVariant"]
|
||||
title = "Brrrand'n"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,29 @@
|
||||
+++
|
||||
categories = ["tutorial"]
|
||||
description = "An interactive tool to generate color variant stylesheets"
|
||||
options = ["themeVariant"]
|
||||
title = "Stylesheet Generator"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
This interactive tool may help you to generate your own color variant stylesheet.
|
||||
|
||||
{{% expand "Show usage instructions" %}}
|
||||
To get started, first select a color variant from the variant selector in the lower left sidebar that fits you best as a starting point.
|
||||
|
||||
The graph is interactive and reflects the current colors. You can click on any of the colored boxes to adjust the respective color. The graph **and the page** will update accordingly.
|
||||
|
||||
The arrowed lines reflect how colors are inherited through different parts of the theme if the descendant isn't overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.
|
||||
|
||||
To better understand this, select the `neon` variant and modify the different heading colors. There, colors for the headings `h2`, `h3` and `h4` are explicitly set. `h5` is not set and inherits its value from `h4`. `h6` is also not set and inherits its value from `h5`.
|
||||
|
||||
Once you've changed a color, the variant selector will show a "My custom variant" entry and your changes are stored in the browser. You can **browse to other pages** and even close the browser **without losing your changes**.
|
||||
|
||||
Once you are satisfied, you can download the new variants file and copy it into your site's `assets/css` directory.
|
||||
|
||||
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Afterwards, you have to adjust the `themeVariant` option in your `hugo.toml` to your chosen file name. For example, if your new variants file is named `theme-my-custom-variant.css`, you have to set `themeVariant='my-custom-variant'` to use it.
|
||||
|
||||
See the docs for [further configuration options](configuration/branding/colors).
|
||||
{{% /expand %}}
|
||||
|
||||
{{% variantgenerator %}}
|
||||
@@ -0,0 +1,8 @@
|
||||
+++
|
||||
categories = ["tutorial"]
|
||||
description = "An interactive tool to generate color variant stylesheets"
|
||||
options = ["themeVariant"]
|
||||
title = "Stylesheet Generrrat'r"
|
||||
weight = 4
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,41 @@
|
||||
+++
|
||||
categories = ["howto"]
|
||||
description = "Provide your own logo and favicon"
|
||||
title = "Logo"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
## Change the Favicon
|
||||
|
||||
If your favicon is an SVG, PNG, or ICO, just drop your image in your site's `assets/images/` or `static/images/` directory and name it `favicon.svg`, `favicon.png`, or `favicon.ico` respectively.
|
||||
|
||||
If you want to adjust your favicon according to your OS settings for light/dark mode, add the image files `assets/images/favicon-light.svg` and `assets/images/favicon-dark.svg` to your site's directory, respectively, corresponding to your file format. In case some of the files are missing, the theme falls back to `favicon.svg` for each missing file. All supplied favicons must be of the same file format.
|
||||
|
||||
If no favicon file is found, the theme will look up the alternative filename `logo` in the same location and will repeat the search for the list of supported file types.
|
||||
|
||||
If you need to change this default behavior, create a new file `layouts/partials/favicon.html` in your site's directory and write something like this:
|
||||
|
||||
````html {title="layouts/partials/favicon.html"}
|
||||
<link rel="icon" href="/images/favicon.bmp" type="image/bmp">
|
||||
````
|
||||
|
||||
## Change the Logo
|
||||
|
||||
By default, only your site title will be shown at the top of the menu. You can [configure this](configuration/sidebar/headerfooter#title), or override the logo partial.
|
||||
|
||||
Create a new file in `layouts/partials/logo.html` of your site. Then write any HTML you want. You could use an `img` HTML tag and reference an image, or you could paste an SVG definition!
|
||||
|
||||
The size of the logo will adapt automatically.
|
||||
|
||||
> [!note]
|
||||
> In case of SVGs, additional styling may be required.
|
||||
|
||||
### Example
|
||||
|
||||
Suppose you've stored your logo as `static/images/logo.png` then your `layouts/partials/logo.html` could look something like this:
|
||||
|
||||
````html {title="layouts/partials/logo.html"}
|
||||
<a id="R-logo" href="{{ partial "permalink.gotmpl" (dict "to" .Site.Home) }}">
|
||||
<img src="{{"images/logo.png" | relURL}}" alt="brand logo">
|
||||
</a>
|
||||
````
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user