Skip to content

Commit

Permalink
add mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
madjin committed Sep 25, 2024
1 parent f0733c8 commit efbcd66
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 0 deletions.
36 changes: 36 additions & 0 deletions extensions/2.0/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# OMI glTF Extensions Documentation

Welcome to the documentation for OMI glTF Extensions. This site contains detailed information about various glTF extensions developed by OMI. Use the navigation menu on the left to explore different extensions.

## Available Extensions

- [KHR_audio_emitter](KHR_audio_emitter/README.md)
- [OMI_audio_ogg_vorbis](OMI_audio_ogg_vorbis/README.md)
- [OMI_audio_opus](OMI_audio_opus/README.md)
- [OMI_link](OMI_link/README.md)
- [OMI_personality](OMI_personality/README.md)
- [OMI_physics_body](OMI_physics_body/README.md)
- [Collider](OMI_physics_body/README.collider.md)
- [Motion](OMI_physics_body/README.motion.md)
- [Trigger](OMI_physics_body/README.trigger.md)
- [OMI_physics_gravity](OMI_physics_gravity/README.md)
- [OMI_physics_joint](OMI_physics_joint/README.md)
- [OMI_physics_shape](OMI_physics_shape/README.md)
- [OMI_seat](OMI_seat/README.md)
- [OMI_spawn_point](OMI_spawn_point/README.md)

## Archived Extensions

- [OMI_collider](Archived/OMI_collider/README.md)

## Getting Started

To get started, choose an extension from the navigation menu on the left. Each extension's documentation provides detailed information about its usage, implementation details, and examples.

## Examples

Many extensions include example files demonstrating their usage. These can be found in the `examples` directory within each extension's folder.

## Contributing

If you'd like to contribute to this documentation or the extensions themselves, please visit our [GitHub repository](https://github.com/your-repo-link) for more information.
53 changes: 53 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
site_name: OMI glTF Extensions
docs_dir: extensions/2.0
theme:
name: material
features:
- navigation.sections
- navigation.indexes
- navigation.top
- toc.integrate
- toc.follow
- search.highlight
- search.suggest
palette:
- media: "(prefers-color-scheme: light)"
primary: indigo
scheme: default
accent: white
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
plugins:
- search
markdown_extensions:
- meta
- attr_list
- md_in_html
use_directory_urls: true
nav:
- Home: index.md
- KHR_audio_emitter: KHR_audio_emitter/README.md
- OMI_audio_ogg_vorbis: OMI_audio_ogg_vorbis/README.md
- OMI_audio_opus: OMI_audio_opus/README.md
- OMI_link: OMI_link/README.md
- OMI_personality: OMI_personality/README.md
- OMI_physics_body:
- Overview: OMI_physics_body/README.md
- Collider: OMI_physics_body/README.collider.md
- Motion: OMI_physics_body/README.motion.md
- Trigger: OMI_physics_body/README.trigger.md
- OMI_physics_gravity: OMI_physics_gravity/README.md
- OMI_physics_joint: OMI_physics_joint/README.md
- OMI_physics_shape: OMI_physics_shape/README.md
- OMI_seat: OMI_seat/README.md
- OMI_spawn_point: OMI_spawn_point/README.md
- Archived:
- OMI_collider: Archived/OMI_collider/README.md

0 comments on commit efbcd66

Please sign in to comment.