jekyll-theme-petridish

Jekyll theme for research project websites 🧫

https://github.com/peterdesmet/petridish

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

bootstrap bootstrap5 jekyll-theme

Keywords from Contributors

mesh sequences interactive hacking
Last synced: 6 months ago · JSON representation ·

Repository

Jekyll theme for research project websites 🧫

Basic Info
Statistics
  • Stars: 56
  • Watchers: 1
  • Forks: 44
  • Open Issues: 22
  • Releases: 5
Topics
bootstrap bootstrap5 jekyll-theme
Created over 6 years ago · Last pushed 12 months ago
Metadata Files
Readme License Citation

README.md

petridish 🧫

Petridish is a Jekyll theme for research project websites. Or your personal blog or lab website. 👩‍🔬 It's mobile-friendly (thanks to Bootstrap 5), free, easy to customize, and designed to work well with GitHub Pages.

Installation

See the demo website for instructions:

Preview

Demo website

screenshot

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/peterdesmet/petridish. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

MIT License


The instructions below can be adapted/included in the README of your site repository.

Usage

This website makes use of the static website generator Jekyll and the Petridish theme. Each commit to main will automatically trigger a new build on GitHub Pages. There is no need to build the site locally, but you can by installing Jekyll and running bundle exec jekyll serve.

Minor changes can be committed directly to main.

Changes requiring review (e.g. new blog posts) should be created in a separate branch and submitted as a pull request. Some guidelines:

  • Use 72dpi as image resolution
  • Place background images in assets/backgrounds/, name them after their corresponding page/post and ideally crop them to 2100 x 700px
  • Place content images in assets/images/, name them after their corresponding page/post + a suffix, e.g. -figure-1
  • Add tags to posts to create relevant groups (e.g. same topic, project).
  • Create internal links as [previous post]({{ '/permalink/to/post/' | relative_url }})

Repo structure

The repository structure follows that of Jekyll websites.

Owner

  • Name: Peter Desmet
  • Login: peterdesmet
  • Kind: user
  • Location: Ghent, Belgium
  • Company: @inbo

Biodiversity informatics geek. Passionate about #opendata and #openscience.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: petridish
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Peter
    family-names: Desmet
    orcid: 'https://orcid.org/0000-0002-8442-8025'
repository-code: 'https://github.com/peterdesmet/petridish'
url: 'https://peterdesmet.com/petridish'
abstract: Jekyll theme for research project websites.
keywords:
  - jekyll
  - theme
license: MIT

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 7
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 13
  • Pull request event: 3
  • Fork event: 2
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 7
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 13
  • Pull request event: 3
  • Fork event: 2

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 409
  • Total Committers: 5
  • Avg Commits per committer: 81.8
  • Development Distribution Score (DDS): 0.022
Past Year
  • Commits: 34
  • Committers: 1
  • Avg Commits per committer: 34.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
peterdesmet p****t@i****e 400
Nicky Nicolson n****n@g****m 6
dependabot[bot] 4****] 1
Jocelyn Pender p****n@g****m 1
Bryan Braun b****7@g****m 1
Committer Domains (Top 20 + Academic)
inbo.be: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 91
  • Total pull requests: 15
  • Average time to close issues: 8 months
  • Average time to close pull requests: 14 days
  • Total issue authors: 8
  • Total pull request authors: 5
  • Average comments per issue: 1.07
  • Average comments per pull request: 0.27
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 2
  • Pull requests: 4
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 4 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • peterdesmet (78)
  • jocelynpender (4)
  • nickynicolson (2)
  • timvantilborgh (2)
  • niconoe (1)
  • dshorthouse (1)
  • Rafnuss (1)
  • mmaslon (1)
Pull Request Authors
  • peterdesmet (10)
  • jocelynpender (2)
  • bryanbraun (1)
  • dependabot[bot] (1)
  • nickynicolson (1)
Top Labels
Issue Labels
enhancement (46) bug (6) wontfix (3) documentation (3) question (2) blocked (1) duplicate (1)
Pull Request Labels
question (1) dependencies (1)

Packages

  • Total packages: 1
  • Total downloads:
    • rubygems 854 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
rubygems.org: jekyll-theme-petridish

Jekyll theme for research project websites

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 854 Total
Rankings
Forks count: 4.2%
Stargazers count: 8.4%
Dependent packages count: 15.7%
Average: 35.0%
Dependent repos count: 47.0%
Downloads: 99.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

package-lock.json npm
  • @fortawesome/fontawesome-free 5.15.4
  • @popperjs/core 2.11.2
  • academicons 1.9.1
  • anchor-js 4.3.1
  • bootstrap 5.1.3
  • font-awesome 4.7.0
  • jquery 3.6.0
package.json npm
  • @fortawesome/fontawesome-free ^5.15.4
  • @popperjs/core ^2.11.2
  • academicons ^1.9.1
  • anchor-js ^4.3.1
  • bootstrap ^5.1.3
  • font-awesome ^4.7.0
  • jquery ^3.6.0
Gemfile rubygems
  • github-pages >= 0 development
jekyll-theme-petridish.gemspec rubygems
  • jekyll >= 3.9