Skip to content

Commit 5f92ee9

Browse files
committed
fix: syntax error
1 parent f06509f commit 5f92ee9

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

publish-share-code/cite-code.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ kernelspec:
1414
+++ {"editable": true, "slideshow": {"slide_type": ""}}
1515

1616
(cite-your-code)=
17-
# Ways to Add a Citation to Your Code
17+
# How to Add a Citation to Your Code
1818

1919
[Sharing](share-your-code) and making your code **citable** supports others **acknowledge your work, build upon it, and give you credit**. Citation further supports making workflows open and documenting all parts of the scientific process.
2020

@@ -29,7 +29,6 @@ kernelspec:
2929

3030

3131
<i class="fa-solid fa-rocket"></i> This lesson assumes that your code is already **hosted on [GitHub or GitLab](share-your-code) with an [open license](open-license).**
32-
:::
3332

3433
(zenodo)=
3534
## What is Zenodo?
@@ -60,7 +59,6 @@ Each release gets a unique DOI, while the repository keeps a persistent record,
6059
1. Go to [zenodo.org](https://zenodo.org/) and sign in using your GitHub account
6160
2. Go to your profile drop-down and select “GitHub
6261

63-
6462
:::{figure} /images/zenodo/zenodo-account.png
6563
:alt: Text here
6664

@@ -147,14 +145,11 @@ Be sure to use the cite-all versions badge, which will always resolve to the mos
147145
Once you have created a GitHub release, you will see a badge next to the repository with a DOI. You can click on that badge to get a copy-able markdown version of the rendered badge that you can add to your README file.
148146
:::
149147

150-
151148
### Step 6: Optional--Add your DOI to the GitHub repo: the citation.cff file
152149

153150
Now that you have a DOI, add a [CITATION.cff](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) file to your GitHub repository to make it easy for others to cite your package.
154151
Once you have a DOI, you can add a [citation.cff file](https://citation-file-format.github.io/) to your GitHub or GitLab repository. A `CITATION.cff` file standardizes citation information, making it easy for others to cite your work correctly.
155152

156-
157-
158153
## What is a DOI?
159154

160155
A **DOI**, or **Digital Object Identifier**, is a unique, permanent identifier assigned to digital content such as academic papers, datasets, software, and other research outputs. It acts like a stable web link that always directs users to the reference content, even if the location of the content changes. DOIs are commonly used in academic publishing to ensure that citations remain valid and materials are easily accessible. But you can also assign DOIs to software, data, and other research outputs and supporting elements.
@@ -165,9 +160,8 @@ By using a DOI, you can make your work more discoverable and citable, enabling o
165160

166161
There are multiple ways to get a DOI for your work and to make your code citable. Each way has its own benefits:
167162

168-
169163
1. **Write and publish a paper about your code in a journal like JOSS (Journal of Open Source Software) via pyOpenSci** if you have written a Python package or another methods-focused scientific Journal. If you go the publication route, you will receive a cross-ref DOI that can be easily connected to your ORCID.
170-
3. **Use a platform like [Zenodo](zenodo)**. If you use Zenodo to create a DOI for your work, you will receive a DOI that is not CrossRef compatible. However, you can still add entries for that DOI in your ORCID profile page.
164+
1. **Use a platform like [Zenodo](zenodo)**. If you use Zenodo to create a DOI for your work, you will receive a DOI that is not CrossRef compatible. However, you can still add entries for that DOI in your ORCID profile page.
171165

172166
### CrossRef vs. Zenodo DOIs - What's the difference?
173167

0 commit comments

Comments
 (0)