{"id":22870961,"url":"https://github.com/percona-lab/pmm-doc-experiment","last_synced_at":"2026-02-06T13:32:15.451Z","repository":{"id":68884152,"uuid":"268814848","full_name":"Percona-Lab/pmm-doc-experiment","owner":"Percona-Lab","description":"The experimental repo for mkdocs testing","archived":false,"fork":false,"pushed_at":"2020-10-06T08:28:09.000Z","size":9023,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-03-31T11:32:23.444Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","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":"LICENSE","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-06-02T13:53:19.000Z","updated_at":"2020-10-06T08:28:12.000Z","dependencies_parsed_at":"2023-03-01T04:16:17.289Z","dependency_job_id":null,"html_url":"https://github.com/Percona-Lab/pmm-doc-experiment","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Percona-Lab/pmm-doc-experiment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpmm-doc-experiment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpmm-doc-experiment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpmm-doc-experiment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpmm-doc-experiment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Percona-Lab","download_url":"https://codeload.github.com/Percona-Lab/pmm-doc-experiment/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Percona-Lab%2Fpmm-doc-experiment/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266465103,"owners_count":23933067,"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-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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:42.979Z","updated_at":"2026-02-06T13:32:15.399Z","avatar_url":"https://github.com/Percona-Lab.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pmm-doc-experiment\n\nThis is an experimental repo for evaluating [MkDocs](https://www.mkdocs.org/)\nas an additional or replacement documention platform for the\nPMM documentation repository ([pmm-doc](https://github.com/percona/pmm-doc)).\n\nThe markdown files were written by Sphinx using the\n[Sphinx markdown builder](https://pypi.org/project/sphinx-markdown-builder/).\n\n## Issues\n\n- The source reST files have hard-wired references that cause broken links.\n- Images rendered with `.. figure::` are missing and must be manually added.\n\n## Installation\n\n### Option 1: Docker\n\nUse a [Docker](https://docs.docker.com/engine/install/) image with all prerequisites already installed:\n\n```bash\n# Clone this repository\ncd pmm-doc-experiment\ndocker run --rm -it -p 8000:8000 -v $(pwd):/mkdocs pauljacobspercona/mkdocs-showcase mkdocs serve --dev-addr=0.0.0.0:8000\n```\n\nOpen \u003chttp://localhost:8000\u003e in a browser.\n\n### Option 2: Native Install\n\n#### Install Prerequisites (Debian/Ubuntu)\n\n```bash\nsudo apt install -y python3 python3-pip\n```\n\n(For other platforms, see \u003chttps://www.python.org/downloads/\u003e.)\n\n#### Check Prerequisites\n\n```bash\npython3 --version # \u003e= 3.5\npip3 --version # \u003e= 20.0.2\n```\n\n#### Install MkDocs and Extensions, Plugins, and Themes\n\n```bash\npip3 install mkdocs\npip3 install mkdocs-exclude\npip3 install mkdocs-macros-plugin\npip3 install mkdocs-material\npip3 install mkdocs-redirects\npip3 install mkdocs-table-reader-plugin\npip3 install pymdown-extensions\npip3 install pygments\n```\n\n#### View Documentation\n\n```bash\n# clone this repository\ncd pmm-doc-experiment\nmkdocs serve\n```\n\nOpen \u003chttp://localhost:8000\u003e\n\n#### Build documentation\n\nTo create a stand-alone static website:\n\n```bash\nmkdocs build\n```\n\nOpen `site/index.html` in your browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona-lab%2Fpmm-doc-experiment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercona-lab%2Fpmm-doc-experiment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercona-lab%2Fpmm-doc-experiment/lists"}