2 releases
new 0.1.1 | Oct 29, 2024 |
---|---|
0.1.0 | Oct 28, 2024 |
#290 in Web programming
243 downloads per month
56KB
1K
SLoC
blog/reblog
blog/reblog aims to provide a platform for folks with strong interests to write at length about them. do you like getting in-depth with things and talking about them? are you a huge nerd about something you want to write about? then it's for you, whatever your interests are.
that's the "blog" in blog/reblog, but it's not just that. you can't write in a vacuum. everyone who writes has to read; books, blogs, anything. the reblogging is sharing and responding to each other's words, providing not just more to think and write about, but the inspiration to do it.
so in sum: blog/reblog gives you a place to write, and lots of reasons to do it.
installation and usage
right now, installation is a bit complex, as is usage. it's still in pre-alpha -- it'll probably stay frustrating for a little while.
because it's just a library for now, you need a working rust development environment, because you'll be writing some code. create a new rust binary with the right dependency:
# create a directory to hold your blog
cargo new --bin my-blog
cd my-blog
# add the blog-reblog dependency
cargo add breb
then you can "configure" it by writing a main.rs
that looks like:
use breb::quick::*;
fn main() {
boilerplate(blog);
}
fn blog(in_dir: std::path::PathBuf) -> FinishedBuilder {
Blog::builder()
.base_dir(in_dir)
.base_url("https://genderphas.ing/")
.name("genderphasing")
.author(Author::new("nic; genderphasing").email("nic@genderphas.ing"))
.serve(AsIs::new("/s/", "s/"))
.serve(Posts::new("/posts", "posts/")
.nav("about", "/about")
.nav("archive", "/archive")
.nav("atom", "/feed.xml"))
.serve(Pages::new("/", "pages/")
.nav("about", "/about")
.nav("archive", "/archive")
.nav("atom", "/feed.xml"))
.serve(Feed::atom("/feed.xml"))
}
for now, for details about what your options are, check the api reference. eventually, expect to see docs here.
once you've configured it like that, you can run it easily:
cargo run
this being a normal rust binary, you can add as much other functionality as you want: custom web-based or native guis, robust command-line arguments, etc.
short-term plans
even in the limited scope of current development, there's still a lot of missing features. i've broken them into release milestones, mostly for my own tracking, and there's zero guarantee that these will be delivered in any particular order.
-
0.2: the meat on the bones
adding a bunch of basic features to make this more broadly useful.
- some way to do templating for auto-generated indices and the like
- some way to pass in templates, since they're hardcoded for now
- rss 2.0 feed generation (since it won't be too much extra work)
-
0.3: a real binary
adding yet more basic features, this time to make it useful as a standalone binary.
- a config file, so you don't need to build a custom binary
longer-term plans
right now, blog/reblog is in a very pre-alpha state. i have the immediate plans listed above, but i also have a longer-term vision for this. this is a personal project, so there's no timeline here, but it'll provide structure to keep me motivated to keep working on this.
- blog/reblog crate: a rust library for doing the static site generation, with a thin wrapper for this blog in particular. technically published, but not really meant to be used yet.
- blog/reblog ssg: a robust, cli-based frontend to that crate. parses markdown, convenient tools for writing and managing posts, and a cli-based way to "reblog".
- blog/reblog cms: a web-based, single-blog-ish frontend. meant for self-hosting, but probably usable for community-hosting too. has a nice web ui over all of the functionality, including rss reading and reblogging.
- finally, blog-reblog.net: a fully functional, multi-user social media site. for any given user, this acts like the cms, but it has an actual concept of "users". probably a much better community-hosted cms.
right now, i'm on phase one. you can use the crate yourself, if you want, but it's not very user-friendly yet.
Dependencies
~8–16MB
~266K SLoC