{"id":19272244,"url":"https://github.com/backstage/techdocs-container","last_synced_at":"2026-01-27T23:49:09.482Z","repository":{"id":37926379,"uuid":"309952053","full_name":"backstage/techdocs-container","owner":"backstage","description":"Docker container that powers the generation of TechDocs static sites","archived":false,"fork":false,"pushed_at":"2025-02-04T19:53:07.000Z","size":73,"stargazers_count":39,"open_issues_count":0,"forks_count":37,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-02-04T20:32:49.561Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/backstage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-04T09:14:42.000Z","updated_at":"2025-02-04T19:48:27.000Z","dependencies_parsed_at":"2024-05-21T15:31:42.071Z","dependency_job_id":"aca57e11-9be5-4c54-99ad-a7189b37c6a3","html_url":"https://github.com/backstage/techdocs-container","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstage%2Ftechdocs-container","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstage%2Ftechdocs-container/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstage%2Ftechdocs-container/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstage%2Ftechdocs-container/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/backstage","download_url":"https://codeload.github.com/backstage/techdocs-container/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240374025,"owners_count":19791330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T20:35:59.534Z","updated_at":"2026-01-27T23:49:04.445Z","avatar_url":"https://github.com/backstage.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# techdocs-container\n\nThis is the Docker container that powers the creation of static documentation sites that are supported by [TechDocs](https://github.com/backstage/backstage/blob/master/plugins/techdocs).\n\n## Getting Started\n\nUsing the TechDocs CLI, we can invoke the latest version of `techdocs-container` via Docker Hub:\n\n```bash\nnpx @techdocs/cli serve\n```\n\n## Local Development\n\n```bash\ndocker build . -t mkdocs:local-dev\n\ndocker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs:local-dev serve -a 0.0.0.0:8000\n```\n\nThen open up `http://localhost:8000` on your local machine.\n\n## Release\n\n1. When you are ready to create a new release head over to [releases](https://github.com/backstage/techdocs-container/releases) and click on `Draft a new release`.\n\n2. 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 `Publish release`.\n\n3. Once released, consider updating the default version used in [techdocs-common's TechdocsGenerator](https://github.com/backstage/backstage/blob/45c04f6ffdeb6ee58361d040ee5feb95d15f0ad8/packages/techdocs-common/src/stages/generate/techdocs.ts#L42).\n\nThe release flow is managed by a [GitHub actions workflow](.github/workflows/release-tag.yml). Whenever a new [release](https://github.com/backstage/techdocs-container/releases) is published on GitHub, the workflow pushes the tag to [DockerHub](https://hub.docker.com/r/spotify/techdocs).\n\nNote: The `latest` tag on DockerHub points to the recent commits in the `main` branch. This is configured by the [main workflow](.github/workflows/main.yml). We recommend using a specific version of the container instead of `latest` release for stability and avoiding unexpected changes.\n\n## Updating PlantUML\n\nPlantUML is a Java based tool which is packaged in a single JAR file. You can find the latest released in their [GitHub repo under Releases](https://github.com/plantuml/plantuml/releases). When updating the Docker file with a new release of PlantUML you'll need to download the relevant JAR file first and then generate a checksum using `sha1sum`. Here are the steps:\n\n1. Download the JAR file: `curl -o plantuml.jar -L https://github.com/plantuml/plantuml/releases/download/v1.2024.6/plantuml-1.2024.6.jar`\n2. Generate the checksum: `sha1sum plantuml.jar`\n3. Update the Dockerfile file with the proper release URL and checksum\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackstage%2Ftechdocs-container","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackstage%2Ftechdocs-container","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackstage%2Ftechdocs-container/lists"}