| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| |
| # ============================================================================= |
| # Apache Ossie Website Configuration |
| # ============================================================================= |
| # This file controls the site: theme, navigation, and plugins. |
| # Landing page content lives in data/home.yml (loaded by mkdocs-macros-plugin). |
| # |
| # Reference docs: |
| # MkDocs: https://www.mkdocs.org/user-guide/configuration/ |
| # Material for MkDocs: https://squidfunk.github.io/mkdocs-material/ |
| # ============================================================================= |
| |
| # --------------------------------------------------------------------------- |
| # Site metadata |
| # Shows in browser tabs, search engine results, and the site footer. |
| # --------------------------------------------------------------------------- |
| site_name: Apache Ossie (incubating) |
| site_url: https://ossie.apache.org |
| site_description: >- |
| Apache Ossie (incubating) is a collaborative, open-source effort |
| dedicated to standardizing semantic model exchange across analytics, AI, |
| and BI platforms. |
| copyright: >- |
| Copyright © 2026 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. <br> |
| Apache, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the |
| Apache Software Foundation in the United States and/or other countries. All other marks mentioned may be |
| trademarks or registered trademarks of their respective owners. |
| |
| # --------------------------------------------------------------------------- |
| # Theme configuration |
| # Controls the visual appearance and behavior of the site. |
| # Docs: https://squidfunk.github.io/mkdocs-material/setup/ |
| # --------------------------------------------------------------------------- |
| theme: |
| name: material |
| custom_dir: overrides |
| logo: assets/images/ossie-logos/Ossie_DarkBlue.svg |
| favicon: assets/images/ossie-logos/logo-mark.svg |
| font: |
| text: Inter |
| palette: |
| scheme: default |
| primary: custom |
| accent: custom |
| features: |
| # Navigation: tabs for sidebar scoping, breadcrumb path |
| - navigation.tabs |
| - navigation.path |
| - navigation.sections |
| - navigation.top |
| - navigation.tracking |
| # Table of contents: follows scroll position |
| - toc.follow |
| # Code blocks: copy button, tabbed language switching, annotations |
| - content.tabs.link |
| - content.code.copy |
| - content.code.annotate |
| |
| # --------------------------------------------------------------------------- |
| # Plugins |
| # search: Built-in full-text search |
| # include-markdown: Includes remote/local markdown at build time |
| # blog: Blog with posts, categories, archive by year |
| # macros: Enables {{ config.extra.* }} access in templates and markdown |
| # |
| # NOTE: include-markdown must come before macros so its directives are |
| # processed first. Custom tags ({! / !}) avoid conflicts with macros' {% %}. |
| # --------------------------------------------------------------------------- |
| plugins: |
| - include-markdown: |
| opening_tag: "{!" |
| closing_tag: "!}" |
| cache: 600 |
| - blog: |
| blog_dir: updates |
| blog_toc: false |
| post_date_format: long |
| post_url_format: "{slug}" |
| categories: false |
| pagination: false |
| - macros |
| |
| # --------------------------------------------------------------------------- |
| # Markdown extensions |
| # These enable advanced formatting in .md files: code highlighting, tabs, |
| # admonitions (callout boxes), emoji icons, tables, and more. |
| # Docs: https://squidfunk.github.io/mkdocs-material/setup/extensions/ |
| # --------------------------------------------------------------------------- |
| markdown_extensions: |
| - pymdownx.highlight: |
| anchor_linenums: true |
| - pymdownx.inlinehilite |
| - pymdownx.snippets |
| - admonition |
| - pymdownx.details |
| - pymdownx.superfences |
| - pymdownx.tabbed: |
| alternate_style: true |
| - pymdownx.mark |
| - pymdownx.tilde |
| - attr_list |
| - pymdownx.emoji: |
| emoji_index: !!python/name:material.extensions.emoji.twemoji |
| emoji_generator: !!python/name:material.extensions.emoji.to_svg |
| - tables |
| - md_in_html |
| - toc: |
| permalink: true |
| - footnotes |
| - def_list |
| |
| # --------------------------------------------------------------------------- |
| # Hooks |
| # Custom Python hooks that run during the build process. |
| # load_data.py: loads all YAML files from data/ as Jinja2 template globals. |
| # --------------------------------------------------------------------------- |
| hooks: |
| - hooks/load_data.py |
| # - hooks/fetch_spec.py # TODO: re-enable when spec rendering is reimplemented |
| |
| # --------------------------------------------------------------------------- |
| # Navigation |
| # Controls the top-level tabs and sidebar menu structure. |
| # Add new pages by creating a .md file in docs/ and listing it here. |
| # Nesting is unlimited -- just indent further under a parent item. |
| # |
| # Example of deeply nested docs: |
| # - Docs: |
| # - Getting Started: |
| # - Installation: docs/getting-started/installation.md |
| # - Configuration: |
| # - Basic: docs/getting-started/config-basic.md |
| # - Advanced: docs/getting-started/config-advanced.md |
| # --------------------------------------------------------------------------- |
| nav: |
| - Home: index.md |
| - About: "/index.html#about" |
| - Community: "/index.html#get-involved" |
| - Updates: updates/ |
| - GitHub: https://github.com/apache/ossie |
| |
| # --------------------------------------------------------------------------- |
| # Extra CSS and JavaScript |
| # These files are loaded on every page in the order listed. |
| # Page-specific stylesheets (e.g. home.css) are loaded in their own templates. |
| # --------------------------------------------------------------------------- |
| extra_css: |
| - assets/stylesheets/bootstrap.min.css |
| - assets/stylesheets/global.css |
| |
| extra_javascript: |
| - assets/javascripts/home.js |
| |
| # --------------------------------------------------------------------------- |
| # Social links |
| # Rendered in the site footer by Material for MkDocs. |
| # --------------------------------------------------------------------------- |
| extra: |
| disclaimer: >- |
| Apache Ossie is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored |
| by the Apache Incubator. Incubation is required of all newly accepted projects until a further |
| review indicates that the infrastructure, communications, and decision making process have |
| stabilized in a manner consistent with other successful ASF projects. While incubation status is not |
| necessarily a reflection of the completeness or stability of the code, it does indicate that the project |
| has yet to be fully endorsed by the ASF. |
| social: |
| - icon: fontawesome/brands/github |
| link: https://github.com/apache/ossie |
| name: Apache Ossie on GitHub |
