Skip to content

Commit 0b6064c

Browse files
Merge pull request #28 from NullHypothesis/auto-deploy
Automatically deploy CensorBib.
2 parents d432134 + 3bcd6f3 commit 0b6064c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2249
-346
lines changed

.github/workflows/build.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Build
2+
on: push
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/checkout@v4
10+
11+
- name: Build
12+
run: |
13+
go build -C src -o ../compiler
14+
./compiler -path references.bib > /dev/null
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Deploy website
2+
on:
3+
push:
4+
branches:
5+
main
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
deploy-website:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Install and Build
18+
run: |
19+
go build -C src -o ../compiler
20+
mkdir build
21+
mv assets build
22+
./compiler -path references.bib > build/index.html
23+
24+
- name: Deploy
25+
uses: JamesIves/github-pages-deploy-action@v4
26+
with:
27+
# Must be identical to where we wrote the HTML to.
28+
folder: build

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
compiler

Makefile

Lines changed: 0 additions & 19 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
Overview
2-
--------
1+
# CensorBib
32

4-
This repository contains the BibTeX file and HTML templates that form the
3+
This repository contains the
4+
[BibTeX file](references.bib)
5+
and
6+
[corresponding tooling](src/)
7+
that powers the
58
[Internet Censorship Bibliography](https://censorbib.nymity.ch).
9+
CensorBib is also available via
10+
[GitHub pages](https://NullHypothesis.github.io/censorbib/)
11+
in case the primary domain is inaccessible to you.
612

7-
Build it
8-
--------
13+
## Contribute
914

10-
You first need [`bibliogra.py`](https://github.com/NullHypothesis/bibliograpy)
11-
to turn the BibTeX file into an HTML bibliography.
15+
To contribute, please create a pull request that adds a new paper or
16+
improves an existing one.
1217

13-
Then, run the following commands to write the bibliography to `OUTPUT_DIR`.
14-
15-
$ ./fetch_pdfs.py references.bib OUTPUT_DIR
16-
$ bibliogra.py -H header.tpl -F footer.tpl -f references.bib OUTPUT_DIR
17-
18-
Acknowledgements
19-
----------------
20-
21-
CensorBib uses [Font Awesome](https://fontawesome.com/license/free) icons
22-
without modification.
23-
24-
Feedback
25-
--------
26-
27-
Contact: Philipp Winter <[email protected]>
18+
> [!TIP]
19+
> Try to mimic the style of existing BibTeX entries. The parser is strict!
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)