Australian BioCommons: customising nf-core workshop series
March 15, 2023 ยท View on GitHub
Workshop title: introduciton to nf-core and customising it for your research.
How to use
- Edit
index.qmdto change the main landing page. This is basically a markdown file. - Edit or create
setup.qmdto change the Setup instruction pages. Same - basically a md file. - Edit
_quarto.ymlto change the dropdown menu options. - Add additional
*.mdfiles to the root dir to have them converted to html files (and add them to_quarto.ymlto make them navigable), if you'd like.
If you want to use the command line instead of VSCode/RStudio (as described below), run the below commands (after activating the correct Python environment, if needed)
quarto render
# First time you create the file, add them to be tracked by github, e.g.
git add docs/*
git commit -am "your comments"
git push
You can browse the result locally by exploring the html files created (note: sometimes figures display locally but not on web and the other way around too.)
For main "content" in md/qmd
- Create files in the
notebooksfolder (for examplenotebooks/1_cont.md). Have a look at what the syntax for Challenges, Objectives, Key Points and Questions is supported in0.0.0_template.md, and use similar syntax across other .md files where needed. - Add links to your content to the navigation configuration in
_quarto.yml. For example, to link to the rendered page fornotebooks/1_cont.md, add a link tonotebooks/1_cont.htmlin_quarto.yml - Type
quarto renderin the terminal - or use VSCode's 'Render Quarto project' command using the command pallette instead.