chore: set up mkdocs

Add mkdocs configuration and relocate the project README to the `docs/` subdirectory, bringing it under the control of mkdocs. This README will still be shown on the project main page per https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes#about-readmes
snyk-labs · Oct 23, 2023 · 25a4bcc · 25a4bcc
1 parent 1d9f524
commit 25a4bcc
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/README.md → docs/README.md b/README.md → docs/README.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,9 @@
+site_name: Snyk Tags Tool
+nav:
+  - Home: README.md
+
+theme:
+  name: readthedocs
+  highlightjs: true
+plugins:
+  - search
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ version = "2.2.1"
 description = "CLI tool designed to manage tags and attributes at scale"
 authors = ["EricFernandezSnyk <[email protected]>"]
 license = "MIT"
-readme = "README.md"
+readme = "docs/README.md"
 repository = "https://github.com/snyk-labs/snyk-tags-tool"
 keywords =["snyk"]