glaxnimate/docs/mkdocs.in.yml

0001 # SPDX-FileCopyrightText: 2019-2023 Mattia Basaglia <dev@dragon.best>
0002 # SPDX-License-Identifier: CC-BY-SA-4.0
0003 site_name: Glaxnimate
0004 site_description: Glaxnimate is a simple and fast vector graphics animation program.
0005 copyright: Copyright (C) 2019-2023
0006 extra:
0007     version: ${PROJECT_VERSION}
0008     name: ${PROJECT_NAME}
0009 theme:
0010     name: cinder
0011     custom_dir: theme
0012     highlightjs: false
0013 repo_url: ${DOCS_REPO_URL}
0014 edit_uri: -/edit/master/docs/docs
0015 use_directory_urls: true
0016 site_url: ${DOCS_SITE_URL}
0017 markdown_extensions:
0018     - fontawesome_markdown
0019     - md_extensions
0020 extra_css:
0021     - /style/style.css
0022 plugins:
0023     - mkdocs-simple-hooks:
0024         hooks:
0025             on_env: "mkdocs_plugin:on_env"
0026 nav:
0027     - index.md
0028     - "Download": download.md
0029     - "Donate": donate.md
0030     - "<i class='fa fa-book'></i> User Manual":
0031         - manual/index.md
0032         - manual/shapes.md
0033         - manual/formats.md
0034         - "User Interface":
0035             - manual/ui/tools.md
0036             - manual/ui/canvas.md
0037             - manual/ui/docks.md
0038             - manual/ui/dialogs.md
0039             - manual/ui/menus.md
0040             - manual/ui/settings.md
0041         - "Tutorials":
0042             - tutorial/index.md
0043             - tutorial/bouncy-ball/index.md
0044             - tutorial/loading-spinner/index.md
0045             - examples/dragon_curve.md
0046         - "Release Notes":
0047             - "0.5.2": release-notes/0.5.2/index.md
0048             - "0.5.3": release-notes/0.5.3/index.md
0049             - "0.5.4": release-notes/0.5.4/index.md
0050     - "<i class='fa fa-hands-helping'></i> Contributing":
0051         - "Introduction": contributing/index.md
0052         - "Scripting":
0053             - contributing/scripting/index.md
0054             - contributing/scripting/plugins.md
0055             - contributing/scripting/examples.md
0056             - "Reference": contributing/scripting/python_reference.md
0057         - "Building From Source":
0058             - "Readme": contributing/read_me.md
0059             - contributing/repository_structure.md
0060             - contributing/cross_compiling.md
0061         - "Writing Code":
0062             - contributing/code/branches.md
0063             - contributing/code/settings.md
0064             - contributing/code/model_objects.md
0065             - contributing/code/misc.md
0066         - "Writing Documentation": contributing/documentation.md
0067         - "Translations": contributing/translations.md
0068         - "Assets": contributing/assets.md
0069         - "Roadmap": contributing/roadmap.md
0070         - "File Format": contributing/json_reference.md
0071     - "<i class='fa fa-globe'></i> Links":
0072         - '<i class="fab fa-telegram"></i> Telegram Chat': ${DOCS_CHAT_URL}
0073         - '<i class="fab fa-gitlab"></i>   Code Browser': ${DOCS_REPO_URL}
0074         - '<i class="fa fa-bug"></i>       Issues': ${URL_ISSUES}
0075         - '<i class="fa-brands fa-mastodon"></i> Mastodon': https://floss.social/@glax
0076         - '<i class="fas fa-external-link-alt"></i> More Links': contributing/links.md