quarto-badge
Badge is an extension for Quarto to provide a shortcode to display software version or anything as a badge.
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 (6.8%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Badge is an extension for Quarto to provide a shortcode to display software version or anything as a badge.
Basic Info
- Host: GitHub
- Owner: mcanouil
- License: mit
- Language: Lua
- Default Branch: main
- Homepage: http://m.canouil.dev/quarto-badge/
- Size: 48.8 KB
Statistics
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 2
- Releases: 9
Topics
Metadata Files
README.md
Badge Extension For Quarto
badge is an extension for Quarto to provide a shortcode to display software version.
Installing
bash
quarto add mcanouil/quarto-badge
This will install the extension under the _extensions subdirectory.
If you're using version control, you will want to check in this directory.
Using
The shortcode {{< badge <key> <value> >}} will display a badge with the given version number.
You can provide any number of badges by specifying an array under the badge key in the _quarto.yml file or in the front matter of the document.
yaml
badge:
- key: current
colour: firebrick
- key: future
class: bg-danger
href: https://github.com/mcanouil/quarto-version-badge
- key: old
class: bg-warning
href: https://github.com/mcanouil/quarto-version-badge/releases/tag/{{value}}
{{value}}will be replaced by the value of the badge.- You can use
colourorcolorto specify the colour of the badge. - You can also use
classto specify a class to add to the badge.
markdown
{{< badge current 1.0.0 >}}
{{< badge future 2.0.0 >}}
{{< badge old 0.1.0 >}}
[!CAUTION] The
hrefattribute is optional and currently breaks the table of contents links when used in headers.
Example
Here is the source code for a minimal example: example.qmd.
Owner
- Name: Mickaël Canouil
- Login: mcanouil
- Kind: user
- Location: Lille, France
- Website: https://mickael.canouil.fr
- Twitter: MickaelCanouil
- Repositories: 28
- Profile: https://github.com/mcanouil
Biostatistician, Ph. D. (& cinephile) @RLille User Group Organiser
Citation (CITATION.cff)
cff-version: 1.2.0
title: "Badge Extension for Quarto"
message: "If you use this project, please cite it as below."
type: software
authors:
- family-names: "Canouil"
given-names: "Mickaël"
orcid: "https://orcid.org/0000-0002-3396-4549"
repository-code: "https://github.com/mcanouil/quarto-badge"
url: "http://m.canouil.dev/quarto-badge/"
license: "MIT"
date-released: "2025-04-05"
version: 2.0.2
GitHub Events
Total
- Release event: 2
- Watch event: 1
- Delete event: 9
- Push event: 12
- Pull request event: 6
- Create event: 5
Last Year
- Release event: 2
- Watch event: 1
- Delete event: 9
- Push event: 12
- Pull request event: 6
- Create event: 5
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Mickaël Canouil | 8****l | 33 |
| github-actions[bot] | 4****] | 2 |
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 10
- Total pull requests: 16
- Average time to close issues: about 1 month
- Average time to close pull requests: 6 days
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 1.4
- Average comments per pull request: 0.0
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- mcanouil (3)
- aronatkins (2)
Pull Request Authors
- mcanouil (11)
- github-actions[bot] (4)