share-to-fediverse-jekyll-theme
This theme generates a microwebsite to share URL to the Fediverse (or Mastodon, at least).
Installation
Add this line to your Jekyll site's Gemfile
:
gem "share-to-fediverse-jekyll-theme"
And add this line to your Jekyll site's _config.yml
:
theme: share-to-fediverse-jekyll-theme
And then execute:
$ bundle
Or install it yourself as:
$ gem install share-to-fediverse-jekyll-theme
Usage
The instance
option on _config.yml
is the default instance used.
Create a share button with:
https://yourwebsite.org/?u=URL&t=TITLE&d=DESCRIPTION
Replacing URL
, TITLE
and DESCRIPTION
for the shareable content.
Contributing
Bug reports and pull requests are welcome on 0xacab.org at https://0xacab.org/sutty/jekyll/share-to-fediverse-jekyll-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Sutty's code of conduct.
Development
To set up your environment to develop this theme, run bundle install
.
Your theme is setup just like a normal Jekyll site! To test your theme,
run bundle exec jekyll serve
and open your browser at
http://localhost:4000
. This starts a Jekyll server using your
theme. Add pages, documents, data, etc. like normal to test your theme's
contents. As you make modifications to your theme and to your content,
your site will regenerate and you should see the changes in the browser
after a refresh, just like normal.
When your theme is released, only the files in _layouts
, _includes
,
_sass
and assets
tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the array in
share-to-fediverse-jekyll-theme.gemspec
accordingly.
License
The theme is available as open source under the terms of the Antifacist MIT License.