Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2026-01-27 04:40:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add Makefile and Markdown linter (#73)

Browse Source 
* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
This commit is contained in:
Adriaan Van Niekerk
2025-10-31 01:06:36 +02:00
committed by GitHub
parent bbe3bd79db
commit 0cd98c67e2
44 changed files with 524 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -53,13 +53,8 @@ See https://python-markdown.github.io/extensions/admonition/
## Local Test
To test it locally:
1. Clone this repo
1. Install the required tools (See also [.github/workflows/build-docs.yaml](.github/workflows/build-docs.yaml)):
```
pip install --upgrade pip
pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material pymdown-extensions mkdocs-enumerate-headings-plugin
```
1. In the main folder of the repo, call `mkdocs serve` (and keep it running).
This will locally generate the documentation.
You can access it under http://127.0.0.1:8000/AI-on-the-edge-device-docs/
Any change to the files will automatically be applied.
2. Run `make install` that creates a virtual environment and installs all the dependencies
3. Run `make serve`. This will locally generate the documentation. You can access it under http://127.0.0.1:8000/AI-on-the-edge-device-docs/
Any change to the files will automatically be applied.
4. Add your edits.
5. Run `make lint-md` and correct any issues before opening a PR.