This is the Docker container that powers the creation of static documentation sites that are supported by TechDocs.
Using the TechDocs CLI, we can invoke the latest version of
techdocs-container via Docker Hub:
npx @techdocs/cli serve
docker build . -t mkdocs:local-dev docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs:local-dev serve -a 0.0.0.0:8000
Then open up
http://localhost:8000 on your local machine.
When you are ready to create a new release head over to releases and click on
Draft a new release.
Use an incremental version number for the release e.g. v2.2.1 and use that as the tag version. Github will create a new tag if the tag doesn't exist. Fill out the rest of the fields and click
Once released, consider updating the default version used in techdocs-common's TechdocsGenerator.
latest tag on DockerHub points to the recent commits in the
main branch. This is configured by the main workflow. We recommend using a specific version of the container instead of
latest release for stability and avoiding unexpected changes.