{"id":26512068,"url":"https://github.com/tacc/mkdocs-tacc","last_synced_at":"2025-12-12T10:40:58.039Z","repository":{"id":267691594,"uuid":"902059254","full_name":"TACC/mkdocs-tacc","owner":"TACC","description":"The documentation theme for TACC Portals","archived":false,"fork":false,"pushed_at":"2025-03-19T23:09:56.000Z","size":2884,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T23:30:45.069Z","etag":null,"topics":["documentation","mkdocs","tacc","theme"],"latest_commit_sha":null,"homepage":"https://tacc.github.io/mkdocs-tacc/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TACC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2024-12-11T20:34:47.000Z","updated_at":"2025-03-19T22:55:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"85f252ab-464e-4415-9521-dc87533a8688","html_url":"https://github.com/TACC/mkdocs-tacc","commit_stats":null,"previous_names":["wesleyboar/core-docs","wesleyboar/mkdocs-tacc","tacc/mkdocs-tacc"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TACC%2Fmkdocs-tacc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TACC%2Fmkdocs-tacc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TACC%2Fmkdocs-tacc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TACC%2Fmkdocs-tacc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TACC","download_url":"https://codeload.github.com/TACC/mkdocs-tacc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244728231,"owners_count":20500023,"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":["documentation","mkdocs","tacc","theme"],"created_at":"2025-03-21T03:18:48.406Z","updated_at":"2025-12-12T10:40:58.032Z","avatar_url":"https://github.com/TACC.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs TACC Theme\n\nA [TACC](https://www.tacc.utexas.edu/)-styled [MkDocs](https://www.mkdocs.org/) theme based on **MkDocs**' own [ReadTheDocs theme](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs).\n\n- **Either** [Create a New MkDocs-TACC Project](#create-a-new-mkdocs-tacc-project)\n- **Or** [Install Theme Into Existing MkDocs Project](#install-theme-into-existing-mkdocs-project)\n\n## Create a New MkDocs-TACC Project\n\n1. Create a repository from our [`mkdocs-tacc-client`](https://github.com/TACC/mkdocs-tacc-client) template. [How?][create-from-template]\n2. In your new repository:\n    - Rename [`mkdocs_tacc_client` directory](https://github.com/TACC/mkdocs-tacc-client/tree/main/mkdocs_tacc_client) to `your_project_name`.\n    - Rename [all instances of `TACC/mkdocs-tacc-client`](https://github.com/search?q=repo%3ATACC%2Fmkdocs-tacc-client+%22TACC%2Fmkdocs-tacc-client%22\u0026type=code) to `YourOrgOrUser/your-repo-name`.\n    - In `pyproject.toml`, change:\n        - the `name` to `your-project-name`\n        - the `description`\n        - the `homepage` URL\n    - In `CONTRIBUTING.md`, change:\n        - the `[issues]:` URL\n        - the `[proposals]:` URL\n    - In `README.md`, change the title.\n\n## Install Theme Into Existing MkDocs Project\n\n1. Enter the directory of your MkDocs project e.g.\n\n    ```shell\n    cd path/to/your/mkdocs/project\n    ```\n\n2. Install the theme (and optional dependencies) e.g.\n\n    ```shell\n    pip install \"mkdocs-tacc[all]\"\n    ```\n\n\u003e [!NOTE]\n\u003e We also offer [detailed instructions](https://tacc.github.io/mkdocs-tacc/) instead.\n\n## How to Use\n\n3. In your `mkdocs.yml`:\n\n    - Set theme name as `tacc_readthedocs`.\n    - Set [typical extensions for this theme](./docs/extensions.md#typical).\n\n## Known Clients\n\n| Status | Repository |\n| - | - |\n| Active | [TACC-Docs](https://github.com/TACC/TACC-Docs)\u003cbr\u003e[digital-porous-media/dpm_docs](https://github.com/digital-porous-media/dpm_docs) |\n| Upcoming | [DesignSafe-CI/DS-User-Guide](https://github.com/DesignSafe-CI/DS-User-Guide) |\n| Potential | [TACC/containers_at_tacc](https://github.com/TACC/containers_at_tacc)\u003cbr\u003e[TACC/life_sciences_ml_at_tacc](https://github.com/TACC/life_sciences_ml_at_tacc) |\n\n## Contributing\n\nWe welcome contributions. Read [\"How to Contribute\"](./CONTRIBUTING.md).\n\n[create-from-template]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftacc%2Fmkdocs-tacc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftacc%2Fmkdocs-tacc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftacc%2Fmkdocs-tacc/lists"}