Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Pinjasaur/bic

Static blog generator, in bash
https://github.com/Pinjasaur/bic

bash cli nix-flake static-blog static-site static-site-generator

Last synced: about 2 months ago
JSON representation

Static blog generator, in bash

Awesome Lists containing this project

README

        


bic

# bic

![Build Status](https://img.shields.io/github/actions/workflow/status/Pinjasaur/bic/ci.yml)

Opinionated minimal static site (blog) generator. Implemented in a single Bash
script.

## Getting Started

Check out the [docs] or [bic-example] repository.

## Local Development

Build (local develop):

```bash
docker build --platform linux/amd64 . -t bic:local
```

Run (local develop) with [bic-example]:

```bash
docker run --platform linux/amd64 --rm -it -v $PWD/../bic-example:/src -v $PWD:/app --entrypoint bash bic:local
```

Run (just build) with [bic-example]:

```bash
docker run --platform linux/amd64 --rm -v $PWD/../bic-example:/src bic:local
```

Run using [nix flakes]

```bash
nix shell github:Pinjasaur/bic --command bic $PWD/../bic-example
```

Local server (ran in [bic-example]):

```bash
npx -y browser-sync --watch --no-notify --extensions html build
```

Run test suite (uses [BATS]):

```bash
bats tests/test.bats --print-output-on-failure
```

## License

[MIT].

[docs]: https://bic.sh/
[bic-example]: https://github.com/Pinjasaur/bic-example
[MIT]: https://pinjasaur.mit-license.org/2021
[nix flakes]: https://www.tweag.io/blog/2020-05-25-flakes
[BATS]: https://github.com/bats-core/bats-core