Skip to content

Commit

Permalink
Add notes on how to add a new story
Browse files Browse the repository at this point in the history
  • Loading branch information
yongrenjie committed Oct 11, 2023
1 parent e4fdd10 commit bfc72f9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,14 @@ conda env create -f binder/environment.yml
Any problems, open an issue!


### Adding a new story

Under the `stories` directory, create a new folder with the name `YYYY-MM-DD-<Title>` and place your notebook inside there.
Make sure you have already run all the cells in your notebook.
That's all!

If your notebook is not ready to be published to the web, you can prefix the folder with an underscore: Quarto will then ignore it.

### About the project

This project was initially formed by a desire to contribute and advance to the analysis of government COVID-19 data.
Expand Down

0 comments on commit bfc72f9

Please sign in to comment.