Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spinalcms/bridgetown-docs-template
A Bridgetown + Tailwind CSS theme for your documentation site
https://github.com/spinalcms/bridgetown-docs-template
bridgetown bridgetown-plugin bridgetownrb docs-site documentation-template documentation-theme tailwindcss theme
Last synced: about 1 month ago
JSON representation
A Bridgetown + Tailwind CSS theme for your documentation site
- Host: GitHub
- URL: https://github.com/spinalcms/bridgetown-docs-template
- Owner: SpinalCMS
- License: mit
- Created: 2022-08-05T16:18:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T09:10:19.000Z (5 months ago)
- Last Synced: 2024-12-19T01:07:36.143Z (about 2 months ago)
- Topics: bridgetown, bridgetown-plugin, bridgetownrb, docs-site, documentation-template, documentation-theme, tailwindcss, theme
- Language: HTML
- Homepage: https://spinalcms.com/resources/bridgetown-documentation-theme-with-tailwind-css/
- Size: 708 KB
- Stars: 18
- Watchers: 1
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bridgetown documentation template using Tailwind CSS
A Bridgetown documentation site theme, built with Tailwind CSS.
## Sponsored By [Spinal](https://spinalcms.com/cms-for-bridgetown/)
You might also be interested in [Rails Designer](https://railsdesigner.com)—the first professionally-designed UI components library for Rails.
## Installation
Run this command to add this plugin to your site's Gemfile:
```shell
$ bundle add bridgetown-docs-template -g bridgetown_plugins
```
Then add the initializer to your configuration in `config/initializers.rb`:
```ruby
init :"bridgetown-docs-template"
```
## Requirements
There are a few requirements for this theme to run.
- [Tailwind CSS](https://tailwindcss.com/)
- [Tailwind CSS Typograhpy](https://tailwindcss.com/docs/typography-plugin)
- [ERB template engine](https://www.bridgetownrb.com/docs/template-engines/erb-and-beyond)
### Minimum frontmatter requirements
The following frontmatter is expected in your collection resources:
- layout: `bridgetown_docs_template/layout`
- title
- description
- category
If 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.
### Add the gem's path in the `content` array of your Tailwind CSS config, like so:
```js
content: [
//…
"path-to-your-gems"
//…
]
```
One way this can be achieved without hardcoding paths is as follows:
```js
const execSync = require("child_process").execSync;
const gemPath = execSync("bundle show bridgetown-docs-template", { encoding: "utf-8" }).trim();
module.exports = {
content: [
...,
gemPath + "/**/*.{html,md,liquid,erb,serb,rb}",
],
...
}
```
## Configuring views/components
This 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).
## Optional configuration options
The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
- name
- email
## Examples
- [Spinal](https://spinalcms.com/docs/)
- [Helptail](https://helptail.com/docs/)
## Related repo's
- [Documentation theme built with Tailwind CSS](https://github.com/SpinalCMS/docs-template)
- [11ty documentation template using Tailwind CSS](https://github.com/SpinalCMS/11ty-docs-template)
- [Astro documentation template using Tailwind CSS](https://github.com/SpinalCMS/astro-docs-template)
## Contributing
1. Fork it (https://github.com/spinalcms/bridgetown-docs-template/fork)
2. Clone the fork using `git clone` to your local development machine.
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request