First clone this repo using the command git clone
.
Once you have the project files locally you can follow the instruction below to build the html book example using quarto environment.
An easy way to manage your project and git is through visual studio code. You need to do the following step-by-step:
- Open VS code, select "File" and open the folder you just cloned from the repository.
- Check the extensions installed. The following extensions are required for the project. You can install those extensions by clicking the tool box icon on the side bar and searching for each one by its name, then clicking "Install".
- Python, by Microsoft
- Quarto, by Quarto
- R, by REditorSupport
- Git History, by Don Jayamanne
- Git Graph, by mhutchie
- Open the terminal bar in VS code.
- Input
quarto check
in the terminal and thenenter
to check the environment setting of you quarto. - Input
quarto preview
in the terminal to open a temperary report on your browser. It may take 1~2 minutes for your first run. You can edit the content in theqmd
file and the report will adapt the changes automatically when you save them. - you can also use the
render
function by opening a new terminal and inputtingquarto render
in the terminal to generate a report in html format in the_book
folder.
More information about quarto can be found here