yams/mkdocs.yml
Trevon 4e6835a04b
Merge pull request #237 from trvon/docs/install-guide
docs: install and setup guide, Why YAMS, and working repo snippets
2026-09-30 18:00:26 -06:00

88 lines
1.9 KiB
YAML

site_name: YAMS
site_description: Yet Another Memory System — local, persistent memory for documents and applications.
site_url: https://trvon.github.io/yams
repo_url: https://git.trevon.dev/trevon/yams
repo_name: git.trevon.dev/trevon/yams
docs_dir: docs
site_dir: site
use_directory_urls: true
# Runtime prompts and packaged skills are source assets, not site pages.
exclude_docs: |
prompts/**
skills/**
nav:
- Home: index.md
- Install: install.md
- Build: BUILD.md
- Benchmarks: benchmarks/index.md
- Roadmap: roadmap.md
- Newsletter: newsletter.md
- Operations:
- Source mirroring: source-mirroring.md
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- navigation.path
- navigation.top
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: blue
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: green
toggle:
icon: material/weather-sunny
name: Switch to light mode
language: en
font:
text: "Outfit"
code: "JetBrains Mono"
logo: assets/yams.png
favicon: assets/yams.png
markdown_extensions:
- admonition
- attr_list
- codehilite
- toc:
permalink: true
- footnotes
- meta
- sane_lists
- smarty
- tables
- pymdownx.details
- pymdownx.highlight
- pymdownx.superfences
plugins:
- search
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/trvon/yams
name: GitHub
- icon: fontawesome/solid/code-branch
link: https://git.trevon.dev/trevon/yams
name: Self-hosted Git mirror
- icon: fontawesome/solid/envelope
link: mailto:support@yamsmemory.ai
name: Email
extra_css:
- assets/retro.css
extra_javascript: []
copyright: "© YAMS"