Skip to content

Commit 354abec

Browse files
committed
add screenshots for rendered citation files
1 parent a325889 commit 354abec

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

episodes/42-software-reuse.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -479,9 +479,12 @@ Software and datasets have no title page, the relevant information is often less
479479

480480
A good way to add citation information is by including a [CITATION.cff](https://citation-file-format.github.io/) file (Citation File Format) in the root of your repository. This plain text file, written in YAML format, contains all the necessary citation details in a structured manner.
481481

482+
483+
![](./fig/github-citation-file-rendered.png){alt='CITATION.cff rendered on GitHub' .image-with-shadow width="600px"}
484+
482485
Platforms like GitHub, Zenodo, and Zotero reuse the citation metadata you provide. GitHub, for example, automatically renders the file on the repository landing page and provides a BibTeX snippet which users can simply copy!
483486

484-
#### Minimal example for a CITATION.cff file
487+
### Minimal example for a CITATION.cff file
485488

486489
```yaml
487490
authors:
141 KB
Loading

0 commit comments

Comments
 (0)