Skip to content

Commit

Permalink
Add notes about writing content
Browse files Browse the repository at this point in the history
  • Loading branch information
sajith committed Apr 3, 2024
1 parent 20cf7ee commit a022008
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,27 @@ sources.

See [index] for an outline of the course material.

## Authoring content

The content in this repository is processed using [Quarto] in order to
generate the website seen at https://xcitecourse.org/.

To add content, do this:

- Download and install Quarto from [quarto.org][Quarto].
- Clone this repository.
- Add/edit content in the form of `.md`, `.qmd`, or `.ipynb` files.
- Open a terminal, and run `quarto preview`, which will start a local
webserver with a live preview.
- Once you are satisfied with your changes, commit them, and push them
to this repository, or submit a pull request.

Once content publish workflow will then take care of

<!-- References -->

[CHESS]: https://www.chess.cornell.edu/
[index]: ./index.md

[Quarto]: https://quarto.org
[x-cite]: https://xcitecourse.org/

0 comments on commit a022008

Please sign in to comment.