Skip to content

Commit

Permalink
docs: improve website homepage (#184)
Browse files Browse the repository at this point in the history
Signed-off-by: Charles-Edouard Brétéché <[email protected]>
  • Loading branch information
eddycharly authored Nov 6, 2024
1 parent 9db519b commit a037650
Show file tree
Hide file tree
Showing 8 changed files with 483 additions and 86 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.cache/
.certs/
.tools/
.venv/
website/site/
/kyverno-envoy-plugin
/charts/*/charts
10 changes: 3 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,7 @@ codegen-helm-docs: ## Generate helm docs
.PHONY: codegen-mkdocs
codegen-mkdocs: ## Generate mkdocs website
@echo Generate mkdocs website... >&2
@$(PIP) install mkdocs
@$(PIP) install --upgrade pip
@$(PIP) install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr mkdocs-rss-plugin mike
@$(PIP) install -r requirements.txt
@mkdocs build -f ./website/mkdocs.yaml

.PHONY: codegen-helm-crds
Expand Down Expand Up @@ -224,10 +222,8 @@ tests: ## Run tests

.PHONY: mkdocs-serve
mkdocs-serve: ## Generate and serve mkdocs website
@echo Generate and serve mkdocs website... >&2
@$(PIP) install mkdocs
@$(PIP) install --upgrade pip
@$(PIP) install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr mkdocs-rss-plugin mike
@echo Generate and servemkdocs website... >&2
@$(PIP) install -r requirements.txt
@mkdocs serve -f ./website/mkdocs.yaml

########
Expand Down
11 changes: 11 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
cairosvg
lunr
mike
mkdocs
mkdocs-include-markdown-plugin
mkdocs-material
mkdocs-minify-plugin
mkdocs-redirects
mkdocs-rss-plugin
git+https://github.com/eddycharly/openapi2jsonschema.git@v3
Pillow
Loading

0 comments on commit a037650

Please sign in to comment.