Merge branch 'master' into chore/refactor-before-publish

.github/workflows/cd-mkdocs

@@ -0,0 +1,22 @@
+name: cd-mkdocs
+on:
+  push:
+    branches:
+      - master
+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: pip install pillow cairosvg
+      - run: mkdocs gh-deploy --force

.github/workflows/cd-mkdocs.yml

@@ -0,0 +1,22 @@
+name: Deploying Documentation
+on:
+  push:
+    branches:
+      - master
+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: pip install pillow cairosvg
+      - run: mkdocs gh-deploy --force

README.md

@@ -1,7 +1,34 @@
-## Contribution
-### Start here - how to setup
-1. setup your credentials .env file
-2. install package requirements (3.10.0)
+<p><img width=20% src="media/logo.png"></p>
 
-## Standards
-1. black python
+> [!NOTE]
+> This package is not officially launched on pypi yet
+
+iracing-garage
+============
+
+`iracing-garage` simplifies extracting data from iRacing API. The package includes all iRacing API endpoints.
+
+## Installation
+
+```bash
+pip install iracing-garage
+```
+
+---
+
+## Wiki
+
+Do you need some help? Check out the articles on the [wiki](wwww.google.com).
+
+---
+
+## Contributing
+
+Please take a look at our [contributing](wwww.google.com) guidelines if you're interested in helping!
+
+---
+
+## License
+You can check out the full license [here](LICENSE)
+
+This project is licensed under the terms of the **MIT** license.

docs/index.md

@@ -0,0 +1,24 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
+
+# Code Block
+```py title="main.py" linenums="1" hl_lines="1 3"
+print("vroomvroom")
+print("vrrrr")
+print("3")
+```

docs/methods.md

@@ -703,4 +703,3 @@ No Description
 link: ```https://members-ng.iracing.com/data/track/get```
 
 ---
-

mkdocs.yml

@@ -0,0 +1,46 @@
+site_name: iRacing Garage
+
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.copy
+  language: en
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+extra:
+  social:
+    - icon: fontawesome/brands/github-alt
+      link: https://github.com/dangkv/iracing_garage
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/in/dangkhoivo/
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - admonition
+  - pymdownx.arithmatex:
+      generic: true
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.mark
+  - attr_list
+
+copyright: |
+  &copy; 2024 <a href="https://github.com/dangkv"  target="_blank" rel="noopener">Dang Khoi Vo</a>

requirements.txt

@@ -7,6 +7,7 @@ distlib==0.3.8
 filelock==3.14.0
 identify==2.5.36
 idna==3.7
+mkdocs-material==9.5.27
 mypy-extensions==1.0.0
 nodeenv==1.8.0
 packaging==24.0