Notable for Bridgetown
A Bridgetown plugin to host notes and attachments from Notable, a markdown-based editor.
Run this command to add this plugin to your site's Gemfile:
$ bundle add bridgetown-notable -g bridgetown_plugins
Currently supports hosting a single Notable data directory at
src/, such that
src/notes holds note entries, and
src/attachments holds attachments.
Requires a bit of setup in bridgetown.config.yml:
defaults: - scope: path: notes/ values: notable: true layout: notable
notable: true on pages, this plugin will:
[[wikilinks]]between Notable pages, with
<a class="wikilink"to hook in styles if desired
- update markdown links/images from
@attachmentto a path Bridgetown can find
- track backlinks in
page.backlinksif that's your thing
You can specify any layout you want, it's provided a
page object like any other.
bundle exec rspecto run the test suite
- Or run
script/cibuildto validate with Rubocop and test with rspec together.
- Fork it (https://github.com/jamie/bridgetown-notable/fork)
- Clone the fork using
git cloneto your local development machine.
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
Releasing (you can delete this section in your own plugin repo)
To release a new version of the plugin, simply bump up the version number in both
package.json, and then run
script/release. This will require you to have a registered account
with both the RubyGems.org and NPM registries.
You can optionally remove the
frontend folder if you don't need to package frontend
assets for Webpack.
If you run into any problems or need further guidance, please check out our Bridgetown community resources where friendly folks are standing by to help you build and release your plugin or theme.
NOTE: make sure you add the
bridgetown-plugin topic to your
plugin's GitHub repo so the plugin or theme will show up on Bridgetown's official Plugin Directory! (There may be a day or so delay before you see it appear.)