From 25a4bcc08e61a6e5d2c0d99e3f196231942b91c9 Mon Sep 17 00:00:00 2001 From: Casey Marshall Date: Fri, 20 Oct 2023 16:52:53 -0500 Subject: [PATCH] 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 --- README.md => docs/README.md | 0 mkdocs.yml | 9 +++++++++ pyproject.toml | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) rename README.md => docs/README.md (100%) create mode 100644 mkdocs.yml diff --git a/README.md b/docs/README.md similarity index 100% rename from README.md rename to docs/README.md diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d6a21b9 --- /dev/null +++ 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 index 0000259..584f388 100644 --- 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 "] license = "MIT" -readme = "README.md" +readme = "docs/README.md" repository = "https://github.com/snyk-labs/snyk-tags-tool" keywords =["snyk"]