mirror of
https://github.com/TagStudioDev/TagStudio.git
synced 2026-06-10 09:33:02 +00:00
5663e6232e
* doc: add REUSE comment headers * doc: add REUSE comment headers for mkDocs overrides The original license text was moved to the LICENSES directory and the MIT license identifier was used since only encoding differences to the MIT license were present. Further, the existing copyright notice was moved to SPDX-FileCopyrightText and one for the TagStudio Contributors was added since the files are not entirely the same as the originals in the mkdocs-material project. * doc: add license information files for the translations * doc: add licence file for oxanium font As stated on [Google Fonts](https://fonts.google.com/specimen/Oxanium/license), this font is licensed under OFL-1.1. * doc: re-license flow_layout.py to GPL-3.0-only This is possible because the Qt example this is based on can be licensed under BSD-3-Clause which is GPL-3.0 compatible. * doc: add REUSE comment header for singleton.py Comparing our implementation with the one it is based on, they really don't have much more in common than the general idea of the implementation, which afaik can't be copyrighted. * doc: Add REUSE comment header for blender_renderer.py We can plainly license this under GPL-3.0 according to https://www.blender.org/about/license/ * doc: add REUSE comment headers to vendored files * doc: add REUSE comment header for rounded_pixmap_style.py Source of name for copyright notice: Answer by eyllanesc: https://stackoverflow.com/users/6622587/eyllanesc Profile links to Github: https://github.com/eyllanesc Stackoverflow licensing: https://stackoverflow.com/help/licensing * doc: add REUSE comment headers * doc: add license information file for icon_mono.svg * doc: add REUSE comment header for files in .github * doc: add REUSE.toml to give license information for various files without spamming .license files * fix: use type parameter instead of subclass * doc: add entries for remaining files in REUSE.toml According to info from github comment by CyanVoxel: https://github.com/TagStudioDev/TagStudio/pull/1361#issuecomment-4423632570 * ci: add REUSE check workflow Src: 'https://reuse.software/dev/#github-actions' * doc: add missing license * doc: fix license for material-design-icons * license: change license to MIT for two files only changes by Computerdores and CyanVoxel * doc: remove unnecessary .license files * doc: fix incorrect license entries * doc: add missing license doc
176 lines
4.4 KiB
YAML
176 lines
4.4 KiB
YAML
# SPDX-FileCopyrightText: (c) TagStudio Contributors
|
|
# SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
|
|
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
|
|
|
|
# MkDocs: https://www.mkdocs.org/
|
|
# Material for MkDocs: https://squidfunk.github.io/mkdocs-material/
|
|
|
|
# To install:
|
|
# pip install mkdocs-material
|
|
|
|
# To run the preview server:
|
|
# mkdocs serve
|
|
|
|
---
|
|
site_name: TagStudio
|
|
site_description: "A User-Focused Photo & File Management System"
|
|
site_url: https://docs.tagstud.io/
|
|
repo_url: https://github.com/TagStudioDev/TagStudio
|
|
edit_uri: blob/main/docs/
|
|
repo_name: TagStudioDev/TagStudio
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/TagStudioDev
|
|
- icon: fontawesome/brands/discord
|
|
link: https://discord.gg/hRNnVKhF2G
|
|
tags:
|
|
Upcoming Feature: upcoming
|
|
|
|
nav:
|
|
- Home:
|
|
- index.md
|
|
- Getting Started:
|
|
- install.md
|
|
- usage.md
|
|
- Developing:
|
|
- developing.md
|
|
- contributing.md
|
|
- style.md
|
|
- Help:
|
|
- help/ffmpeg.md
|
|
- Using Libraries:
|
|
- libraries.md
|
|
- entries.md
|
|
- preview-support.md
|
|
- search.md
|
|
- ignore.md
|
|
- macros.md
|
|
- Fields:
|
|
- fields.md
|
|
- Tags:
|
|
- tags.md
|
|
- colors.md
|
|
- Updates:
|
|
- changelog.md
|
|
- roadmap.md
|
|
- Schema History:
|
|
- library-changes.md
|
|
|
|
theme:
|
|
name: material
|
|
custom_dir: overrides
|
|
palette:
|
|
# Palette toggle for automatic mode
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/lightbulb-auto-outline
|
|
name: Switch to Light Mode
|
|
# Palette toggle for light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/lightbulb
|
|
name: Switch to Dark Mode
|
|
# Palette toggle for dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/lightbulb-night-outline
|
|
name: Switch to System Preference
|
|
logo: assets/icon_mono.svg
|
|
favicon: assets/icon.ico
|
|
font:
|
|
code: Jetbrains Mono
|
|
language: en
|
|
features:
|
|
- content.action.edit
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
- content.tooltips
|
|
- navigation.indexes
|
|
- navigation.instant
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
# - navigation.tabs.sticky
|
|
- navigation.tracking
|
|
- search.suggest
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
tag:
|
|
upcoming: material/flask-outline
|
|
|
|
markdown_extensions:
|
|
|
|
# Python Markdown
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
|
|
# Python Markdown Extensions
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
- pymdownx.snippets
|
|
|
|
plugins:
|
|
- search
|
|
- tags
|
|
- social: # social embed cards
|
|
enabled: !ENV [CI, false] # enabled only when running in CI (eg GitHub Actions)
|
|
- redirects:
|
|
redirect_maps:
|
|
"develop.md": "developing.md"
|
|
"library/entry.md": "entries.md"
|
|
"library/field.md": "fields.md"
|
|
"library/index.md": "libraries.md"
|
|
"library/library_search.md": "search.md"
|
|
"library/tag_categories.md": "tags.md"
|
|
"library/tag_color.md": "colors.md"
|
|
"library/tag.md": "tags.md"
|
|
"updates/changelog.md": "changelog.md"
|
|
"updates/roadmap.md": "roadmap.md"
|
|
"updates/schema_changes.md": "library-changes.md"
|
|
"utilities/ignore.md": "ignore.md"
|
|
"utilities/macro.md": "macros.md"
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
- https://fonts.googleapis.com/css2?family=Bai+Jamjuree:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;1,200;1,300;1,400;1,500;1,600;1,700&display=swap
|