| title | SIH Quarto Training template |
|---|
- We recommend storing all notebooks (.ipynb) or R files (as .qmd or .rmd) in the
notebooksfolder.
-
Clone this repository and
ParallelPython. -
Edit
index.qmdto change the main landing page. -
Edit or create
setup.qmdto change the Setup instruction pages. -
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). -
Download [Quarto](https://quarto.org/. VSCode also has an extension Quarto Extension to render the training.
-
On the command line after Quarto is installed, type
quarto render. Afterwhich,open -a "firefox" docs/index.htmlcan be run to view the rendered training.
- If using Python, you will need to have Jupyter and Quarto installed to convert the notebooks and render them for the web.
- If using R, you will need rmarkdown, xml2 and X to have the notebooks generate properly and link out to the documentation, as specified in the
_quarto.ymlfile. - The building from Jupyter notebooks will NOT re-render all of the notebooks unless you use the
quarto render notebook.ipynb --executecommand - Building from R will by default re-render all of the outputs
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.)