jmpicnic/action-build-mkdocs

Reusable Action to generate mkdocs.

Trust Signals

name	description	required	default
docs-dir	Directory where the mkdocs.yml and requirements.txt file are expected to be and from where the content directory can be accessed (as configured in mkdocs.yml)	—	.
site-target-dir	Directory where the site is to be generated, RELATIVE TO `docs-dir`	—	./site
requirements-file-name	The name of the Python requirements file relative to docs-dir	—	requirements.txt
mkdocs-file-name	The name of the mkdocs config file relative to docs-dir	—	mkdocs.yml
for-techdocs	Whether the generation is intended to be used with techdocs-cli to publish to Backstage	—	True
python-version	The version of Python to use	—	3.12

name	description
generated-site	The directory where the generated site is placed