Files
inventree-website/mkdocs.yml
T
Oliver dd7d563e79 Zensical Refactor (#300)
* refactor into zensical

* adjust nav layout

* more nav changes

* update features page

* open external hero links in new tab

* consolidate small pages

* add legacy page redirects

* tweak content

* further cleanup

* adjust netlify config

* disable redirect

* remove redirect script

* fix tag splitting for plugins

* Display plugin metadata on left-hand side

* revert icon changes

* move gallery to index page

* Add page deascriptions

* fix image size for carousel

* adjust theme
2026-11-22 22:40:17 +11:00

233 lines
8.2 KiB
YAML

# The website is built with Zensical (https://zensical.org), which reads this
# mkdocs-format config. Build with:
# zensical build && python scripts/post_build.py
#
# The theme setup mirrors the InvenTree documentation (docs.inventree.org).
# Project
site_name: InvenTree
site_url: https://inventree.org/
site_description: >-
InvenTree is an open-source inventory management system, providing intuitive parts management and stock control for businesses and hobbyists alike.
site_author: InvenTree
copyright: Copyright © 2021-now InvenTree
# No repo_url - the GitHub repository widget is not shown in the header
# Theme
theme:
name: material
variant: modern
custom_dir: overrides
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: light blue
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: light blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
logo: assets/logo.png
favicon: assets/favicon.ico
features:
- content.code.copy
- header.autohide
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.top
- toc.follow
extra_css:
- stylesheets/splide.min.css
- stylesheets/extra.css
- https://cdn.jsdelivr.net/npm/@tabler/icons-webfont@3.31.0/dist/tabler-icons.min.css
extra_javascript:
- javascripts/splide.min.js
- javascripts/extra.js
# Navigation
# Blog posts, news items and plugin pages are not listed here - they are
# discovered automatically (posts by the blog plugin, plugins by the index pages).
nav:
- Blog:
- Blog: blog/index.md
- News: news/index.md
- Features:
- Features: features.md
- Deploy: deploy.md
- Demo: demo.md
- Alternatives: alternatives.md
- Ecosystem: extend/index.md
- Mobile App: extend/app.md
- Plugins:
- Plugins: plugins/index.md
- Community Plugins:
- All Plugins: plugins/community.md
- By Category: plugins/categories.md
- By Tag: plugins/tags.md
- Publishers: plugins/publishers.md
- Community:
- About: about.md
- Team: about/team.md
- Get Support: support.md
- Contribute: contribute.md
- Fund InvenTree: fund.md
- Newsletter: newsletter.md
- Docs: https://docs.inventree.org/en/stable/
- Demo: https://demo.inventree.org/
# Plugins
plugins:
- search:
enabled: false
- meta
- blog:
blog_dir: blog
blog_toc: true
authors_file: .authors.yml
post_date_format: long
post_url_format: "{date}/{slug}"
post_url_date_format: yyyy/MM/dd
post_readtime: true
archive_name: Blog Archive
archive_toc: true
pagination_per_page: 10
- blog:
blog_dir: news
blog_toc: true
authors_file: .authors.yml
post_date_format: long
post_url_format: "{date}/{slug}"
post_url_date_format: yyyy/MM/dd
post_readtime: false
archive_name: News Archive
archive_toc: true
pagination_per_page: 20
- rss:
match_path: "blog/posts/.*"
feed_title: InvenTree Blog
date_from_meta:
as_creation: date
as_update: date
feeds_filenames:
rss_created: blog/feed_rss_created.xml
rss_updated: blog/feed_rss_updated.xml
json_created: blog/feed_json_created.json
json_updated: blog/feed_json_updated.json
- rss:
match_path: "news/posts/.*"
feed_title: InvenTree News
date_from_meta:
as_creation: date
as_update: date
feeds_filenames:
rss_created: news/feed_rss_created.xml
rss_updated: news/feed_rss_updated.xml
json_created: news/feed_json_created.json
json_updated: news/feed_json_updated.json
- macros:
module_name: main
# Only pages with 'render_macros: true' are rendered, so that template
# syntax in posts and plugin READMEs (e.g. Django label templates) is left alone
render_by_default: false
on_error_fail: true
- redirects:
redirect_maps:
# Old Jekyll pages
'publishers.md': 'plugins/publishers.md'
'functions.md': 'features.md'
'digitalocean.md': 'deploy.md#digitalocean'
'extend/api.md': 'extend/index.md#rest-api'
'extend/plugin/index.md': 'plugins/index.md'
'extend/integrate/index.md': 'extend/index.md#third-party-tools'
# Old publisher pages (/<publisher>)
'LavissaWoW.md': 'plugins/publishers.md#lavissawow'
'SergeoLacruz.md': 'plugins/publishers.md#sergeolacruz'
'afwkiers.md': 'plugins/publishers.md#afkiwers'
'lippoliv.md': 'plugins/publishers.md#lippoliv'
'matmair.md': 'plugins/publishers.md#matmair'
'melektron.md': 'plugins/publishers.md#melektron'
'piramja.md': 'plugins/publishers.md#piramja'
'schrodingersgat.md': 'plugins/publishers.md#schrodingersgat'
'wolflu05.md': 'plugins/publishers.md#wolflu05'
# Old plugin pages (/<author>/<plugin>)
'melektron/inventree-adv-sheet-label.md': 'plugins/inventree-adv-sheet-label.md'
'matmair/inventree-apprise.md': 'plugins/inventree-apprise.md'
'SchrodingersGat/inventree-brother-plugin.md': 'plugins/inventree-brother-plugin.md'
'wolflu05/inventree-bulk-plugin.md': 'plugins/inventree-bulk-plugin.md'
'SchrodingersGat/inventree-consolidated-shipping.md': 'plugins/inventree-consolidated-shipping.md'
'wolflu05/inventree-cups-plugin.md': 'plugins/inventree-cups-plugin.md'
'lippoliv/inventree-default-salesorder-items.md': 'plugins/inventree-default-salesorder-items.md'
'wolflu05/inventree-dymo-plugin.md': 'plugins/inventree-dymo-plugin.md'
'SchrodingersGat/inventree-harmonized-codes.md': 'plugins/inventree-harmonized-codes.md'
'LavissaWoW/inventree-ipn-generator.md': 'plugins/inventree-ipn-generator.md'
'afkiwers/inventree-kicad.md': 'plugins/inventree-kicad.md'
'SchrodingersGat/inventree-mcp.md': 'plugins/inventree-mcp.md'
'piramja/inventree-niimbot-plugin.md': 'plugins/inventree-niimbot-plugin.md'
'SchrodingersGat/inventree-order-history.md': 'plugins/inventree-order-history.md'
'matmair/inventree-rapidoc.md': 'plugins/inventree-rapidoc.md'
'wolflu05/inventree-report-lsp-plugin.md': 'plugins/inventree-report-lsp-plugin.md'
'SchrodingersGat/inventree-rolling-stocktake.md': 'plugins/inventree-rolling-stocktake.md'
'SchrodingersGat/inventree-stock-forecasting.md': 'plugins/inventree-stock-forecasting.md'
'SergeoLacruz/inventree-supplier-panel.md': 'plugins/inventree-supplier-panel.md'
'SchrodingersGat/inventree-test-statistics.md': 'plugins/inventree-test-statistics.md'
'SchrodingersGat/inventree-wireviz.md': 'plugins/inventree-wireviz.md'
'matmair/inventree-zapier.md': 'plugins/inventree-zapier.md'
'SergeoLacruz/inventree-zebra-plugin.md': 'plugins/inventree-zebra-plugin.md'
'wolflu05/inventree-zebra.md': 'plugins/inventree-zebra.md'
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- meta
- tables
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.magiclink:
# Link @mentions to GitHub profiles (previously done by jekyll-mentions)
repo_url_shorthand: true
user: inventree
repo: InvenTree
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
- pymdownx.tasklist
- toc:
permalink: true
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/inventree/inventree
name: InvenTree on GitHub
- icon: fontawesome/brands/mastodon
link: https://chaos.social/@InvenTree
name: InvenTree on Mastodon
- icon: fontawesome/brands/reddit
link: https://reddit.com/r/inventree
name: InvenTree on Reddit
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/inventreedb
name: InvenTree on Twitter
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/inventree/inventree
name: InvenTree on Docker
use_directory_urls: true
strict: true
site_dir: site