breb is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install breb

It will make the breb command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall breb uninstalls.

Adding `breb` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add breb

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

breb = "0.1.2"

The breb library will be automatically available globally. Read the breb library documentation.

Back to the crate overview.

Readme

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.

project planning

...all occurs on my website. currently, as i'm the only developer, it's a read-only page.

Installing the command-line executable

Adding breb library as a dependency

Adding `breb` library as a dependency