{"id":22870975,"url":"https://github.com/percona-lab/percona-doc-docker","last_synced_at":"2025-08-25T22:09:10.406Z","repository":{"id":68884112,"uuid":"283121874","full_name":"Percona-Lab/percona-doc-docker","owner":"Percona-Lab","description":"Docker files for PMM documentation builds","archived":false,"fork":false,"pushed_at":"2025-02-20T11:37:42.000Z","size":32,"stargazers_count":0,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T11:32:21.192Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Percona-Lab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-28T06:29:06.000Z","updated_at":"2023-06-09T17:45:13.000Z","dependencies_parsed_at":"2023-12-05T15:29:40.111Z","dependency_job_id":"388e05d0-59a2-4dd0-abd4-c4c216953991","html_url":"https://github.com/Percona-Lab/percona-doc-docker","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Percona-Lab/percona-doc-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpercona-doc-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpercona-doc-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpercona-doc-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpercona-doc-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Percona-Lab","download_url":"https://codeload.github.com/Percona-Lab/percona-doc-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpercona-doc-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272139150,"owners_count":24880253,"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","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-12-13T13:16:45.505Z","updated_at":"2025-08-25T22:09:10.376Z","avatar_url":"https://github.com/Percona-Lab.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# percona-doc-docker\n\nDocker images that include dependencies for building Sphinx- and MkDocs-based [Percona](https://www.percona.com/software/documentation/) documentation.\n\n- `mkdocs`: An Ubuntu-based image for building MkDocs/Markdown documentation.\n- `sphinx`: Based on the official [Sphinx](https://hub.docker.com/r/sphinxdoc/sphinx) `sphinxdoc/sphinx` image.\n- `sphinx-latexpdf`: Based on the official [Sphinx](https://hub.docker.com/r/sphinxdoc/sphinx-latexpdf) `sphinxdoc/sphinx-latexpdf` image.\n\n## Usage\n\n### MkDocs projects\n\nPerform a build (`mkdocs build`):\n\n```sh\ndocker run --rm -v $(pwd):/docs perconalab/pmm-doc-md\n```\n\nRun the live preview local server (`mkdocs serve`):\n\n```sh\ndocker run --rm -p 8000:8000 -v $(pwd):/docs perconalab/pmm-doc-md mkdocs serve -a 0.0.0.0:8000\n```\n\nOpen your browser at \u003chttp://localhost:8000\u003e\n\nCreate PDF:\n\n```sh\ndocker run --rm -v $(pwd):/docs -e ENABLE_PDF_EXPORT=1 perconalab/pmm-doc-md mkdocs build -t material\n```\n\n([Read more](https://github.com/percona/pmm-doc/blob/main/README.md))\n\n### Sphinx projects\n\nFor HTML:\n\n```sh\ndocker run --rm -v $(pwd):/docs perconalab/percona-doc-sphinx make clean html\n```\n\nFor PDF:\n\n```sh\ndocker run --rm -v $(pwd):/docs perconalab/percona-doc-sphinx-latexpdf make latexpdf\n```\n\nBoth assume a `./Makefile` and Sphinx source files in `./source`.\n\n## Contents\n\nMkDocs packages and plugins:\n\n- [mkdocs](https://www.mkdocs.org/) - MkDocs itself.\n- [mkdocs-macros-plugin](https://pypi.org/project/mkdocs-macros-plugin/) - Various useful macros.\n- [mkdocs-exclude](https://pypi.org/project/mkdocs-exclude/) - For excluding files from MkDocs processing.\n- [markdown-include](https://pypi.org/project/markdown-include/) - For including .md files in others.\n- [mkdocs-material](https://pypi.org/project/mkdocs-material/) - Base theme.\n- [mkdocs-with-pdf](https://pypi.org/project/mkdocs-with-pdf/) - Builds PDF.\n- [plantuml-markdown](https://github.com/mikitex70/plantuml-markdown) - For [PlantUML](https://plantuml.com/) diagrams.\n- [mkdocs-git-revision-date-plugin](https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin) - For 'date last changed' page information.\n- [mkdocs-material-extensions](https://pypi.org/project/mkdocs-material-extensions/) - For icons.\n- [mkdocs-bootstrap-tables-plugin](https://github.com/byrnereese/mkdocs-bootstrap-tables-plugin) - Adds a bootstrap class to tables making them render better.\n- [mkdocs-enumerate-headings-plugin](https://pypi.org/project/mkdocs-enumerate-headings-plugin/) For numbered headings.\n- [mkdocs-section-index](https://github.com/oprypin/mkdocs-section-index) - Add links to section nodes.\n- [mike](https://github.com/jimporter/mike) - Tool for building and managing versions.\n- [lightgallery](https://github.com/g-provost/lightgallery-markdown) - For zooming images.\n\nAdditional Fonts:\n\n- [Chivo](https://fonts.google.com/specimen/Chivo) - To match Percona.com website theme.\n\n### Sphinx image\n\nSphinx extensions:\n\n- [sphinx-copybutton](https://sphinx-copybutton.readthedocs.io/) Adds a copy button to code blocks.\n- [sphinx-gitstamp](https://pypi.org/project/sphinx-gitstamp/) Git datestamp.\n- [sphinx-tabs](https://pypi.org/project/sphinx-tabs/) Allows for tabbed content blocks.\n- [sphinx_markdown_builder](https://pypi.org/project/sphinx-markdown-builder/) Writes Markdown files from rst sources.\n- [sphinx_markdown_parser](https://pypi.org/project/sphinx-markdown-parser/) Allows for Markdown files in a Sphinx/rst project.\n- [sphinxcontrib-srclinks](https://pypi.org/project/sphinxcontrib-srclinks/) Adds various page links (e.g. to Github) to navigation bar.\n- [sphinx-reload](https://pypi.org/project/sphinx-reload/) Automatically rebuilds and serves a Sphinx project.\n- [pymdown-extensions](https://facelessuser.github.io/pymdown-extensions/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona-lab%2Fpercona-doc-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercona-lab%2Fpercona-doc-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona-lab%2Fpercona-doc-docker/lists"}