Skip to content
Implementation plan for the US Research Software Sustainability Institute
TeX CSS Other
Branch: master
Clone or download

README.md

URSSI Conceptualization plan

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. GitHub Actions Workflow for commits to master

Instructions for editing the git book

To update chapters, edit the text for any of the Rmd files in the repository. The syntax is standard markdown. References are in Pandoc format (e.g. [@ref-key]). Copy your references to any new bib file (to avoid conflicts) and use this yml at the top of your chapter

---
bibliography: ["references.bib"]
biblio-style: "apalike"
link-citations: true
---

Replace references.bib with the name of your bib file.

Building the book

GitHub actions will build the book. It takes ~4-10 minutes to build and you can see progress by clicking on the Actions tab and navigating to the current build.

Branches

Only commit to master. Never commit to gh-pages. The actions will automatically push to that orphan branch.

Converting Google doc to markdown

You can use this Google doc extension to convert a block of text to markdown and paste that into a Rmd here.

You can’t perform that action at this time.