https://github.com/jabref/blog.jabref.org
Repository for JabRef's blog
https://github.com/jabref/blog.jabref.org
bibliography jabref latex
Last synced: 2 months ago
JSON representation
Repository for JabRef's blog
- Host: GitHub
- URL: https://github.com/jabref/blog.jabref.org
- Owner: JabRef
- License: cc-by-4.0
- Created: 2016-04-24T17:02:47.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T13:08:31.000Z (over 1 year ago)
- Last Synced: 2024-04-14T10:45:32.770Z (about 1 year ago)
- Topics: bibliography, jabref, latex
- Language: Ruby
- Homepage: https://blog.jabref.org
- Size: 28.7 MB
- Stars: 8
- Watchers: 12
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# JabRef's blog
> This repository contains the source of the [JabRef blog](https://blog.jabref.org/).
Feel free to send blog entries.
Find details in our [CONTRIBUTING.md](CONTRIBUTING.md) file.
The layout is based on [Chirpy](https://github.com/cotes2020/jekyll-theme-chirpy).
We use [Jekyll](https://jekyllrb.com/) as static site generator.
See [GitHub pages](https://pages.github.com/) for more details on the mechanics behind.
## Local Development
For local development, follow the [Jekyll installation instructions](https://jekyllrb.com/docs/installation/).
Installing the latest version of ruby followed by `gem install bundler` should be enough.
Afterwards, run
```terminal
bundle install
jekyll serve --livereload
```
and go to in your browser.
On Windows, using a dockerized environment is recommended:
```terminal
docker run -p 4000:4000 --rm --volume="C:\git-repositories\blog.jabref.org":/srv/jekyll jekyll/jekyll:4 jekyll serve
```
In case you get errors regarding `Gemfile.lock`, just delete `Gemfile.lock` and rerun.
Incremental building is also possible:
```terminal
docker run -p 4000:4000 --rm --volume="C:\git-repositories\blog.jabref.org":/srv/jekyll jekyll/jekyll:4 jekyll serve --incremental
```
## Updating the theme
1. Update `Gemfile`
2. Update assets:
1. `cd assets/lib`
2. `git pull`
3. `cd ../..`
3. git commit and PR creation
4. In case build fails because of missing assets, roll back the assets to the commit matching the release version of the theme.
## Adding a blog entry for a new version
### Contributors list
See for an example for the list of contributors.
To get the list of contributors, use [github-contributors-list](https://github.com/koppor/github-contributors-list)
1. `jbang gcl@koppor/github-contributors-list --repository JabRef/jabref c:\git-repositories\jabref --startrevision=v5.13 --endrevision=v5.15 --filter=koppor,calixtus,Siedlerchr,tobiasdiez,but,k3KAW8Pnf7mkmdSMPHz27,HoussemNasri,apps/dependabot,apps/githubactions,ThiloteE,dependabot[bot],dependabot`
2. Copy and paste the Markdown
3. Preview
4. Double check with
5. Double check with merged PRs: . On 2023-10-22 (when the JavaScript-variant was used), contributors with PRs being merged on the release date did not show up. Example: