Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add mkdocs template for sync files from other repository #395

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/sync-files.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,10 @@
- source: .prettierignore
- source: .prettierrc.yaml
- source: .yamllint.yaml

- repository: autowarefoundation/autoware-documentation
files:
- source: mkdocs-base.yaml
dest: mkdocs.yaml
pre-commands: |
sd " - macros" " - macros:\n include_yaml:\n - autoware_interfaces: yaml/autoware-interfaces.yaml" mkdocs-base.yaml
95 changes: 95 additions & 0 deletions mkdocs-base.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
site_name: Autoware Documentation
site_url: https://autowarefoundation.github.io/autoware-documentation
repo_url: https://github.com/autowarefoundation/autoware
edit_uri: https://github.com/autowarefoundation/autoware-documentation/edit/main/docs/
docs_dir: docs
copyright: Copyright © 2023 The Autoware Foundation

theme:
name: material
features:
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.footer
favicon: assets/images/autoware-foundation.png
icon:
logo: fontawesome/solid/car
repo: fontawesome/brands/github
language: en
palette:
- scheme: default
primary: white
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
primary: grey
toggle:
icon: material/weather-night
name: Switch to light mode

extra:
font:
text: Roboto
code: Roboto Mono
version:
provider: mike

extra_css:
- assets/css/extra.css
- https://use.fontawesome.com/releases/v5.15.4/css/all.css

extra_javascript:
- assets/js/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
- awesome-pages
- exclude:
regex:
- ^(?!(.*/)?assets/).*\.(?!(.*\.)?md|(.*\.)?svg|(.*\.)?png|(.*\.)?gif|(.*\.)?jpg).*$
- ^(.*/)?[^.]*$
- macros
- mkdocs-video
- same-dir
- search

markdown_extensions:
- abbr
- admonition
- attr_list
- codehilite:
guess_lang: false
- fontawesome_markdown
- footnotes
- md_in_html
- mdx_math
- mdx_truly_sane_lists:
nested_indent: 2
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
format: svg
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: "#"
toc_depth: 3