feat: import ods-mkdoc-theme (#1)

Co-authored-by: Loïc Laussel <[email protected]>

.browserslistrc

@@ -0,0 +1 @@
+last 4 years

.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+dist/
+build/
+ods_mkdocs_theme.egg-info/
+site/

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+[email protected] or [email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include ods_mkdocs_theme *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff *.woff2 *.yml
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+include README.md
+include LICENSE

NOTICE.txt

@@ -0,0 +1,12 @@
+Parts list under Orange SA Copyright
+Copyright (C) 2016 - 2023 Orange SA All rights reserved
+
+The following parts are proprietary information of Orange.
+You shall not use or display any trade names, trademarks, service marks, products names, illustrations or designs used within the software
+or displayed on this website (https://boosted.orange.com) and owned by Orange SA and its subsidiaries,
+in whole or part of, in any medium, except as required for reasonable and customary use in describing the origin of the software
+and reproducing the content of the NOTICE and DOCUMENTATION files.
+Any use or displaying shall constitute an infringement under intellectual property laws of France and international conventions.
+
+ods_mkdocs_theme/assets/images/favicon.ico
+ods_mkdocs_theme/assets/images/orange-logo.svg

mkdocs.yml

@@ -0,0 +1,56 @@
+site_name: Orange Design System MkDocs Theme
+site_url: https://github.com/Orange-OpenSource/ods-mkdocs-theme
+site_author: Orange
+site_description: "Orange Design System MkDocs Theme provides a MkDocs theme for Orange."
+repo_url: https://github.com/Orange-OpenSource/ods-mkdocs-theme
+copyright: "Orange Design System MkDocs Theme is licensed under the <a href='https://github.com/Orange-OpenSource/ods-mkdocs-theme/blob/main/LICENSE'>MIT license</a>"
+
+theme:
+  name: ods-mkdocs-theme
+
+plugins:
+  - search:
+      prebuild_index: true
+# Configuration of all Material MkDocs extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - codehilite
+  - def_list
+  - footnotes
+  - md_in_html
+  - meta
+  - toc:
+      permalink: true
+      toc_depth: 3
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  # - pymdownx.emoji:
+  #    emoji_index: !!python/name:materialx.emoji.twemoji
+  #    emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.escapeall
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - tables