{"id":14069315,"url":"https://github.com/posit-dev/product-doc-theme","last_synced_at":"2025-07-11T07:05:17.195Z","repository":{"id":218117624,"uuid":"745539773","full_name":"posit-dev/product-doc-theme","owner":"posit-dev","description":"Shared theme for Posit product documentation","archived":false,"fork":false,"pushed_at":"2025-06-10T23:16:13.000Z","size":796,"stargazers_count":6,"open_issues_count":11,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-10T23:20:17.948Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://docs.posit.co/","language":"SCSS","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/posit-dev.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","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,"zenodo":null}},"created_at":"2024-01-19T14:59:57.000Z","updated_at":"2025-06-10T23:08:54.000Z","dependencies_parsed_at":"2025-04-10T00:37:54.969Z","dependency_job_id":"93eb326c-fc44-4546-92fb-0243e3697c32","html_url":"https://github.com/posit-dev/product-doc-theme","commit_stats":null,"previous_names":["posit-dev/product-doc-theme"],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/posit-dev/product-doc-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posit-dev%2Fproduct-doc-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posit-dev%2Fproduct-doc-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posit-dev%2Fproduct-doc-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posit-dev%2Fproduct-doc-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/posit-dev","download_url":"https://codeload.github.com/posit-dev/product-doc-theme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posit-dev%2Fproduct-doc-theme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264752813,"owners_count":23658724,"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"],"created_at":"2024-08-13T07:06:50.997Z","updated_at":"2025-07-11T07:05:17.184Z","avatar_url":"https://github.com/posit-dev.png","language":"SCSS","readme":"# product-doc-theme\n\nShared theme for Posit product documentation\n\n## Usage\n\n**!!! WARNING: Cookie Consent will be managed by GTM (not the theme) in v7.0.1 of the theme. Please check with Ashley Henry prior to bumping your theme to latest (v7.0.1) so WebOps can opt the site in for tracking.**\n\nFirst, install the extension:\n\n```bash\nquarto add posit-dev/product-doc-theme@v7.0.1\n```\n\nNext, update your project type and format in `_quarto.yml`:\n\n```yaml\nproject:\n  title: \"Posit Documentation\"\n  type: posit-docs\n```\n\n### Additional configuration entries\n\nThe following entries may be unique to each product. Please review the following and make manual updates to your project, as required.\n\n#### Navbar\n\nIf you have `website.navbar.right` entries in your `_quarto.yml`,\nmerge the following with the existing entries:\n\n```\nwebsite:\n  navbar:\n    right:\n      - icon: \"list\"\n        menu:\n          - text: \"docs.posit.co\"\n            href: \"https://docs.posit.co\"\n          - text: \"Posit Support\"\n            href: \"https://support.posit.co/hc/en-us/\"\n```\n\n#### Footer\n\nUse the following `website.page-footer` in your `_quarto.yml`:\n\n```\nwebsite:\n  page-footer:\n    left: |\n      Copyright \u0026copy; 2000-{{\u003c env CURRENT_YEAR \u003e}} Posit Software, PBC. All Rights Reserved.\n    center: |\n      Posit PRODUCT {{\u003c env PRODUCT_VERSION \u003e}}\n    right:\n      - icon: question-circle-fill\n        aria-label: 'Link to Posit Support'\n        href: \"https://support.posit.co/hc/en-us\"\n      - text: '\u003ca href=\"#\" id=\"open_preferences_center\" title=\"Manage your cookie preferences\"\u003e\u003ci class=\"bi bi-cookie\"\u003e\u003c/i\u003e\u003c/i\u003e\u003c/a\u003e'\n        aria-label: 'Cookie Prefs'\n      - icon: lightbulb-fill\n        aria-label: 'Link to Posit Solutions'\n        href: \"https://solutions.posit.co/\"\n      - text: \"\u003cimg alt='Link to main Posit site' src='/_extensions/posit-docs/assets/images/posit-icon-fullcolor.svg' id='footer-right-posit-logo'\u003e\"\n        href: \"https://posit.co/\"\n```\n\nMake the following modifications:\n\n-   **Product name:** Replace the `PRODUCT` placeholder with the product name.\n\n-   **Product version:** Adapt the `PRODUCT_VERSION` variable for your product\n    based on how that information is made available. The example project gets\n    a default environment variable value from the\n    [`_environment`](https://quarto.org/docs/projects/environment.html) file.\n    \n    You may need to dynamically define `PRODUCT_VERSION` before rendering your\n    documentation.\n    \n    ```bash\n    export PRODUCT_VERSION=$(cat version.txt)\n    ```\n\n-   **Copyright:** Copyright dates are represented as a range from the year of\n    first product release until now. Adapt the `CURRENT_YEAR` variable for\n    your product and how that information is made available. The example\n    project gets a default environment variable value from the\n    [`_environment`](https://quarto.org/docs/projects/environment.html) file.\n\n    You may need to dynamically define `CURRENT_YEAR` before rendering your\n    documentation.\n    \n    ```bash\n    export CURRENT_YEAR=$(date \"+%Y\")\n    ```\n\n-   **Images:** Copy the two images from the extension into your project and update the `src` paths.\n\n    For example, you may have a top-level `images` directory:\n\n    ```bash\n    cp _extensions/posit-dev/posit-docs/assets/images/posit-guide-ltmd.svg images\n    cp _extensions/posit-dev/posit-docs/assets/images/posit-icon-fullcolor.svg images\n    ```\n\n    These images are also available [from\n    GitHub](https://github.com/posit-dev/product-doc-theme/tree/main/_extensions/posit-docs/assets/images).\n\nBy copy/pasting and editing these entries into your project's yml, those entries will overwrite 1:1 entries in the `_extension.yml`.\n\n## Development\n\nIf you are modifying this extension, use Quarto to preview your changes\nagainst the sample project defined here.\n\n```bash\nquarto preview\n```\n\n### Release\n\nTo release a new version of this theme:\n\n1.  Make sure that the extension declares the target version and documents its\n    changes.\n\n    1.  Update\n        [`README.md`](https://github.com/posit-dev/product-doc-theme/blob/main/README.md);\n        installation instructions reference the latest release version.\n    1.  Update\n        [`_extensions/posit-docs/_extension.yml`](https://github.com/posit-dev/product-doc-theme/blob/main/_extensions/posit-docs/_extension.yml);\n        the extension declares its version.\n    1.  Update\n        [`changelog.md`](https://github.com/posit-dev/product-doc-theme/blob/main/changelog.md);\n        make sure recent changes are announced.\n\n    Commit and merge both changes to `main`.\n\n2.  Tag the target commit and push the tag.\n\n    ```bash\n    git tag -a v1.1.0 -m 'Release 1.1.0'\n    git push origin v1.1.0\n    ```\n\n3.  Create a GitHub release from [that tag](https://github.com/posit-dev/product-doc-theme/tags).\n\n\n## Additional resources\n\n- [bslib](https://github.com/rstudio/bslib/)\n- [Quarto](https://quarto.org/)\n- [Bootstrap](https://getbootstrap.com/docs/5.0/getting-started/introduction/)\n","funding_links":[],"categories":["SCSS"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposit-dev%2Fproduct-doc-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fposit-dev%2Fproduct-doc-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposit-dev%2Fproduct-doc-theme/lists"}