{"id":18895742,"url":"https://github.com/spinalcms/bridgetown-docs-template","last_synced_at":"2025-06-17T23:38:20.223Z","repository":{"id":57747672,"uuid":"521703530","full_name":"SpinalCMS/bridgetown-docs-template","owner":"SpinalCMS","description":"A Bridgetown + Tailwind CSS theme for your documentation site ","archived":false,"fork":false,"pushed_at":"2024-09-09T09:10:19.000Z","size":725,"stargazers_count":18,"open_issues_count":1,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T04:44:26.601Z","etag":null,"topics":["bridgetown","bridgetown-plugin","bridgetownrb","docs-site","documentation-template","documentation-theme","tailwindcss","theme"],"latest_commit_sha":null,"homepage":"https://spinalcms.com/resources/bridgetown-documentation-theme-with-tailwind-css/","language":"HTML","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/SpinalCMS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2022-08-05T16:18:00.000Z","updated_at":"2024-12-17T11:01:28.000Z","dependencies_parsed_at":"2024-11-08T08:31:41.074Z","dependency_job_id":"90fb1f9f-3e11-4635-9d8b-95f6d4066b8a","html_url":"https://github.com/SpinalCMS/bridgetown-docs-template","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/SpinalCMS/bridgetown-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalCMS%2Fbridgetown-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalCMS%2Fbridgetown-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalCMS%2Fbridgetown-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalCMS%2Fbridgetown-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpinalCMS","download_url":"https://codeload.github.com/SpinalCMS/bridgetown-docs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpinalCMS%2Fbridgetown-docs-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260458846,"owners_count":23012504,"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":["bridgetown","bridgetown-plugin","bridgetownrb","docs-site","documentation-template","documentation-theme","tailwindcss","theme"],"created_at":"2024-11-08T08:29:49.649Z","updated_at":"2025-06-17T23:38:15.210Z","avatar_url":"https://github.com/SpinalCMS.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bridgetown documentation template using Tailwind CSS\n\nA Bridgetown documentation site theme, built with Tailwind CSS.\n\n\n\u003cimg src=\"https://github.com/spinalcms/bridgetown-docs-template/blob/main/bridgetown-docs-preview.jpg?raw=true\" alt=\"preview of the Bridgetown documentation theme, built with Tailwind CSS\" /\u003e\n\n\n## Sponsored By [Spinal](https://spinalcms.com/cms-for-bridgetown/)\n\n\u003ca href=\"https://spinalcms.com/cms-for-bridgetown/\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/988051/183079316-af747ef2-42a9-47d8-9a0c-488ed4b6a689.jpg\" alt=\"Spinal CMS logo\" width=\"200\"/\u003e\n\u003c/a\u003e\n\nYou might also be interested in [Rails Designer](https://railsdesigner.com)—the first professionally-designed UI components library for Rails.\n\n\n## Installation\n\nRun this command to add this plugin to your site's Gemfile:\n\n```shell\n$ bundle add bridgetown-docs-template -g bridgetown_plugins\n```\n\nThen add the initializer to your configuration in `config/initializers.rb`:\n\n```ruby\ninit :\"bridgetown-docs-template\"\n```\n\n\n## Requirements\n\nThere are a few requirements for this theme to run.\n\n- [Tailwind CSS](https://tailwindcss.com/)\n- [Tailwind CSS Typograhpy](https://tailwindcss.com/docs/typography-plugin)\n- [ERB template engine](https://www.bridgetownrb.com/docs/template-engines/erb-and-beyond)\n\n### Minimum frontmatter requirements\n\nThe following frontmatter is expected in your collection resources:\n\n- layout: `bridgetown_docs_template/layout`\n- title\n- description\n- category\n\nIf you want to show the “video” or “quick links” section—likely in your docs root, add `show_videotour: true` and `show_quicklinks: true` to your root's markdown file.\n\n\n### Add the gem's path in the `content` array of your Tailwind CSS config, like so:\n\n```js\ncontent: [\n  //…\n  \"path-to-your-gems\"\n  //…\n]\n```\n\nOne way this can be achieved without hardcoding paths is as follows:\n\n```js\nconst execSync = require(\"child_process\").execSync;\nconst gemPath = execSync(\"bundle show bridgetown-docs-template\", { encoding: \"utf-8\" }).trim();\n\nmodule.exports = {\n  content: [\n    ...,\n    gemPath + \"/**/*.{html,md,liquid,erb,serb,rb}\",\n  ],\n  ...\n}\n```\n\n## Configuring views/components\n\nThis theme makes heavy use of [Bridgetown's components](https://www.bridgetownrb.com/docs/components). If you want to make certain tweaks to any part, it's easy to change any component. Just follow [this guide](https://www.bridgetownrb.com/docs/commands/plugins#copying-files-out-of-plugin-source-folders).\n\n\n## Optional configuration options\n\nThe plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.\n\n- name\n- email\n\n## Examples\n\n- [Spinal](https://spinalcms.com/docs/)\n- [Helptail](https://helptail.com/docs/)\n\n## Related repo's\n\n- [Documentation theme built with Tailwind CSS](https://github.com/SpinalCMS/docs-template)\n- [11ty documentation template using Tailwind CSS](https://github.com/SpinalCMS/11ty-docs-template)\n- [Astro documentation template using Tailwind CSS](https://github.com/SpinalCMS/astro-docs-template)\n\n\n## Contributing\n\n1. Fork it (https://github.com/spinalcms/bridgetown-docs-template/fork)\n2. Clone the fork using `git clone` to your local development machine.\n3. Create your feature branch (`git checkout -b my-new-feature`)\n4. Commit your changes (`git commit -am 'Add some feature'`)\n5. Push to the branch (`git push origin my-new-feature`)\n6. Create a new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinalcms%2Fbridgetown-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspinalcms%2Fbridgetown-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspinalcms%2Fbridgetown-docs-template/lists"}