From e5b9e86f2141bf8a7f7bfa764be177d4e4a0b8e8 Mon Sep 17 00:00:00 2001 From: Onuralp SEZER Date: Thu, 21 Mar 2024 22:03:51 +0300 Subject: [PATCH] =?UTF-8?q?doc:=20=F0=9F=93=9A=20initial=20mkdocs-material?= =?UTF-8?q?=20website=20config=20with=20dark/light=20theme=20added?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Onuralp SEZER --- .github/workflows/publish-doc.yml | 30 ++++++ .gitignore | 160 ++++++++++++++++++++++++++++++ .pre-commit-config.yaml | 28 ++++++ README.md | 4 +- docs/index.md | 7 ++ mkdocs.yml | 55 ++++++++++ 6 files changed, 282 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/publish-doc.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/publish-doc.yml b/.github/workflows/publish-doc.yml new file mode 100644 index 0000000..a19376c --- /dev/null +++ b/.github/workflows/publish-doc.yml @@ -0,0 +1,30 @@ +name: Publish Documentation Website 📚 + +on: + push: + branches: + - main + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.ref}} + cancel-in-progress: true + +permissions: + contents: write + pages: write + pull-requests: write + + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: 🔄 Checkout code + uses: actions/checkout@v4 + - name: 🐍 Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + - run: pip install "mkdocs-material" "mkdocs-material[imaging]" + - run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..68bc17f --- /dev/null +++ b/.gitignore @@ -0,0 +1,160 @@ +# 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/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..356ecb8 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,28 @@ + +ci: + autofix_prs: true + autoupdate_schedule: weekly + autofix_commit_msg: "fix(pre_commit): 🎨 auto format pre-commit hooks" + autoupdate_commit_msg: "chore(pre_commit): ⬆ pre_commit autoupdate" + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: end-of-file-fixer + - id: trailing-whitespace + - id: check-yaml + exclude: mkdocs.yml + - id: check-executables-have-shebangs + - id: check-toml + - id: check-case-conflict + - id: check-added-large-files + - id: detect-private-key + - id: end-of-file-fixer + - id: mixed-line-ending + + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.39.0 + hooks: + - id: markdownlint + args: ['--disable','MD013','MD024','--fix'] diff --git a/README.md b/README.md index e59b493..aedaa42 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ _Note_: To contribute, send a pull request to this repository. Note that this re ### Platforms - [Hugging Face Hub](https://huggingface.co/): Collaborative platform for machine learning. Discover hundreds of thousands of open-source models able to work off-the-shelf in [/models](https://huggingface.co/models). - + ### Development Platform - [ONNX Runtime](https://onnxruntime.ai/): Platform agnostic model runtime to use ML models. @@ -154,4 +154,4 @@ _Note_: The foundation model can be found under their associated task. ## Other -- [Raycast](https://github.com/raycast/extensions) Automate commands on macOS apps with a local ollama LLM, with Raycast extensions. \ No newline at end of file +- [Raycast](https://github.com/raycast/extensions) Automate commands on macOS apps with a local ollama LLM, with Raycast extensions. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d3a1f96 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +--- +hide: + - navigation +--- + + +--8<-- "README.md" diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..3e248c9 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,55 @@ +site_name: awesome-osml-for-devs +site_url: https://merveenoyan.github.io/awesome-osml-for-devs/ +site_author: merveenoyan +site_description: List of resources, libraries and more for developers who would like to build with open-source machine learning off-the-shelf +repo_name: merveenoyan/awesome-osml-for-devs +repo_url: https://github.com/merveenoyan/awesome-osml-for-devs +edit_uri: https://github.com/merveenoyan/awesome-osml-for-devs/tree/main/docs +copyright: Awesome Osml For Developers 2024. All rights reserved. + +nav: + - Home: index.md + +theme: + name: 'material' + features: + - navigation.tracking + - content.code.copy + - content.tooltips + - content.code.annotate + + palette: + - scheme: default + primary: 'custom' + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + - scheme: slate + primary: 'custom' + toggle: + icon: material/brightness-4 + name: Switch to light mode + + font: + text: Roboto + code: Roboto Mono + features: + - content.code.copy + - content.code.annotate + +plugins: + - search + +markdown_extensions: + - admonition + - attr_list + - md_in_html + - pymdownx.tabbed: + alternate_style: true + - toc: + permalink: true + - pymdownx.snippets: + check_paths: true + - pymdownx.highlight: + anchor_linenums: true