📄 | .gitignore |
📄 | COPYING |
📄 | README.md |
📄 | TODO.md |
📄 | conf.py |
📄 | install.sh |
📄 | scuttleblog.py |
README.md
Summary
Scuttleblog creates a blog from a Scuttlebutt journal, using Scuttlebot and Hugo.
Goals
- Visitors from Web 1.0 can read your blog.
- You can write your blog using a typical Scuttlebutt client, such as Patchwork.
- You can write your blog without a persistent or frequent internet connection, and without direct contact with whoever hosts your blog.
- You can manage day-to-day aspects of your blog, such as its name and description, using a typical Scuttlebutt client, such as Patchwork.
- Scuttlebutt acts as the comments section.
Semi-goals
Nice to have, but not why we're here.
- Acts as a window into the wider Scuttleverse social network.
- Gracefully handles awkwardly-formatted posts.
Use it
Set up
- On Ubuntu 17.10: install using install.sh.
- Tell conf.py your Scuttlebutt user identity.
Update the blog
Periodically:
- Run scuttleblog.py.
- (Optionally,
run
hugo server
from inside hugo/ and view a preview with Hugo's internal web server.) - Sync the contents of hugo/public/ to your server.
How it works
- Scuttleblog starts Scuttlebot, and uses it to fetch the specified identity's posts and metadata.
- It manipulates the data into the format Hugo expects for a blog.
- Then it runs Hugo to generate the blog.
Built with git-ssb-web