A Bridgetown documentation site theme, built with Tailwind CSS.
You might also be interested in Rails Designer—the first professionally-designed UI components library for Rails.
Run this command to add this plugin to your site's Gemfile:
$ bundle add bridgetown-docs-template -g bridgetown_plugins
Then add the initializer to your configuration in config/initializers.rb
:
init :"bridgetown-docs-template"
There are a few requirements for this theme to run.
The following frontmatter is expected in your collection resources:
bridgetown_docs_template/layout
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.
content
array of your Tailwind CSS config, like so:content: [
//…
"path-to-your-gems"
//…
]
One way this can be achieved without hardcoding paths is as follows:
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}",
],
...
}
This theme makes heavy use of Bridgetown's components. If you want to make certain tweaks to any part, it's easy to change any component. Just follow this guide.
The plugin will automatically use any of the following metadata variables if they are present in your site's _data/site_metadata.yml
file.
git clone
to your local development machine.git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)