| README.mdView |
|---|
| 1 | 1 … | # Summary |
| 2 | 2 … | |
| 3 | | -**Scuttleblog** creates a blog from a [Scuttlebutt][] journal, using [Scuttlebot][] and [Hugo][]. |
| 3 … | +**Scuttleblog** creates a blog from a [Scuttlebutt][] journal, |
| 4 … | +using [Scuttlebot][] and [Hugo][]. |
| 4 | 5 … | |
| 5 | 6 … | [Scuttlebutt]: https://www.scuttlebutt.nz/ |
| 6 | 7 … | [Scuttlebot]: http://scuttlebot.io/ |
| 7 | 8 … | [Hugo]: https://gohugo.io/ |
| 8 | 9 … | |
| 9 | 10 … | |
| 10 | | -# How to use it |
| 11 … | +## Goals |
| 11 | 12 … | |
| 13 … | +* Visitors from Web 1.0 can read your blog. |
| 14 … | +* You can write your blog using a typical Scuttlebutt client, |
| 15 … | + such as Patchwork. |
| 16 … | +* You can write your blog without |
| 17 … | + a persistent or frequent internet connection, |
| 18 … | + and without direct contact with whoever hosts your blog. |
| 19 … | +* You can manage day-to-day aspects of your blog, |
| 20 … | + such as its name and description, |
| 21 … | + using a typical Scuttlebutt client, |
| 22 … | + such as Patchwork. |
| 23 … | +* Scuttlebutt acts as the comments section. |
| 24 … | + |
| 25 … | + |
| 26 … | +### Semi-goals |
| 27 … | + |
| 28 … | +Nice to have, but not why we're here. |
| 29 … | + |
| 30 … | +* Acts as a window into the wider Scuttleverse social network. |
| 31 … | +* Gracefully handles awkwardly-formatted posts. |
| 32 … | + |
| 33 … | + |
| 34 … | +# Use it |
| 35 … | + |
| 12 | 36 … | ## Set up |
| 13 | 37 … | |
| 14 | | -1. On Ubuntu 17.10: install using install.sh. |
| 15 | | -2. Enter your Scuttlebutt user identity into conf.py. |
| 38 … | +1. On Ubuntu 17.10: |
| 39 … | + install using install.sh. |
| 40 … | +2. Tell conf.py your Scuttlebutt user identity. |
| 16 | 41 … | |
| 17 | 42 … | |
| 18 | 43 … | ## Update the blog |
| 19 | 44 … | |
| 20 | 45 … | Periodically: |
| 21 | 46 … | |
| 22 | 47 … | 1. Run scuttleblog.py. |
| 23 | | -2. (Optionally, run `hugo server` from inside hugo/ and view a preview with Hugo's internal web server.) |
| 48 … | +2. (Optionally, |
| 49 … | + run `hugo server` from inside hugo/ |
| 50 … | + and view a preview with Hugo's internal web server.) |
| 24 | 51 … | 3. Sync the contents of hugo/public/ to your server. |
| 25 | 52 … | |
| 26 | 53 … | |
| 27 | 54 … | # How it works |
| 28 | 55 … | |
| 29 | | -* Scuttleblog starts Scuttlebot, and uses it to fetch the specified identity's posts and metadata. |
| 56 … | +* Scuttleblog starts Scuttlebot, |
| 57 … | + and uses it to fetch the specified identity's posts and metadata. |
| 30 | 58 … | * It manipulates the data into the format Hugo expects for a blog. |
| 31 | 59 … | * Then it runs Hugo to generate the blog. |
| 32 | 60 … | |