Skip to content

Commit

Permalink
Merge pull request #9 from Sydney-Informatics-Hub/issue-13
Browse files Browse the repository at this point in the history
Restructure docs according to diataxis
  • Loading branch information
georgiesamaha authored Sep 12, 2024
2 parents 23cb8bf + 5e63d3f commit 94f2773
Show file tree
Hide file tree
Showing 43 changed files with 3,215 additions and 4,063 deletions.
76 changes: 44 additions & 32 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,60 @@ project:
output-dir: docs

website:
title: "Nextflow DSL2 template user guide"
bread-crumbs: false
title: "**Template-nf user guide**"
navbar:
background: primary
# Top navigation bar with high-level sections
right:
- text: "Home"
href: index.qmd
- text: "Tutorial"
href: notebooks/demo.qmd
- text: "Components"
href: notebooks/components.qmd
- text: "How-to Guides"
href: notebooks/how-to.qmd
- text: "Best Practices"
href: notebooks/best-practices.qmd
- text: "Resources"
href: notebooks/resources.qmd
search: true
sidebar:
style: "floating"
logo: "figs/SIH_logo.png"
search: true
contents:
- index.qmd
- template.qmd
- section: "**Template components**"
collapse-level: 1
contents:
- text: "Tutorial"
href: notebooks/demo.qmd
- text: "How-to Guides"
href: notebooks/how-to.qmd
- section: "Template Components"
href: notebooks/components.qmd
contents:
- notebooks/main-nf.qmd
- notebooks/nextflow-config.qmd
- notebooks/modules.qmd
- notebooks/bin.qmd
- notebooks/configs.qmd
- notebooks/bits.qmd
- notebooks/resource-config.qmd
- notebooks/software.qmd
- notebooks/demo.qmd
- notebooks/hands-on.qmd
- notebooks/guides.qmd
- resources.qmd
cookie-consent:
type: express
style: simple
palette: light
policy-url: https://www.sydney.edu.au/privacy-statement.html
google-analytics: "G-TNWWV3HK57"

body-footer: "<div style='font-size: 14px;'>All materials copyright Sydney Informatics Hub, University of Sydney</div>"

- section: "Best Practices"
href: notebooks/best-practices.qmd
contents:
- notebooks/channels.qmd
- notebooks/resource-config.qmd
- notebooks/software.qmd

format:
html:
toc: false
theme:
light: flatly
dark: darkly
css: styles.scss
code-link: true
code-fold: false
code-overflow: scroll
highlight-style: github
page-layout: full


theme: simplex
css: styles.scss
toc: false
toc-location: left
toc-depth: 2
code-overflow: wrap
code-link: true
code-fold: false
highlight-style: github
#page-layout: full
Binary file added docs/figs/SIH_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
425 changes: 127 additions & 298 deletions docs/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 94f2773

Please sign in to comment.