$adding initial doc files

.github/.env

@@ -0,0 +1 @@
+WORKFLOW_TYPE='gh-pages'

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs: 
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.github/workflows/deploy.yml

@@ -0,0 +1,24 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths: 
+      - 'README.md'
+      - 'overrides/**'
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'requirements.txt'
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    uses: ObsidianPublisher/actions/.github/workflows/deploy.yml@main
+    secrets:
+      GH_PAT: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/index.yml

@@ -0,0 +1,43 @@
+name: Index Creation
+
+on: 
+  workflow_dispatch:
+    inputs:
+      category_name:
+        type: string
+        required: true
+        description: "The new folder name"
+      path:
+        type: string
+        required: false
+        description: "The path of the new folder. Ex: category/subcategory"
+      description: 
+        type: string
+        required: false
+        description: "The description of the category."
+      toc_hide:
+        type: boolean
+        required: false
+        description: "Hide the toc in the index file."
+      nav_hide:
+        type: boolean
+        required: false
+        description: "Hide the navigation menu in the index file."
+      dry_run:
+        type: boolean
+        required: false
+        description: "Do not create new category index, just log."
+
+jobs:
+  run:
+    uses: ObsidianPublisher/actions/.github/workflows/index.yml@main
+    with:
+      category_name: ${{ inputs.category_name}}
+      path: ${{ inputs.path}}
+      description: ${{ inputs.description}}
+      toc_hide: ${{ inputs.toc_hide}}
+      nav_hide: ${{ inputs.nav_hide}}
+      dry_run: ${{ inputs.dry_run}}
+    secrets:
+      GH_PAT: ${{ secrets.GITHUB_TOKEN }}
+

.github/workflows/maintenance.yml

@@ -0,0 +1,14 @@
+name: Repository maintenance
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  maintenance:
+    uses: ObsidianPublisher/actions/.github/workflows/maintenance.yml@main
+    with:
+      CLEAN: true
+      DRY_RUN: false
+    secrets:
+      GH_PAT: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update.yml

@@ -0,0 +1,12 @@
+name: Get latest release from template
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  update:
+    uses: ObsidianPublisher/actions/.github/workflows/update.yml@main
+    with:
+      AUTO_MERGE: false
+    secrets:
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -1,160 +1,4 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.vscode/settings.json
+desktop.ini
+Pipfile
+Pipfile.lock