Skip to content

Commit 00acbbc

Browse files
committed
🔧 Template: Add .jupytext-sync-ipynb to .gitignore
To write the documentation, it would be ideal to be able to just write in a Jupyter notebook, so you can just run the cells locally and test the content. However, the `.ipynb` format is JSON, which is very cumbersome and leads to large and hard to read diffs. Jupytext sync is a tool for writing notebooks in `.ipynb` format, and syncing them to a `.md` file, see: https://marketplace.visualstudio.com/items?itemName=caenrigen.jupytext-sync The Markdown format is also used by our supported documentation tools. Here we add the directory that Jupytext sync creates to the `.gitignore` to avoid committing the `.ipynb` files it generates.
1 parent 8b096d0 commit 00acbbc

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

template/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,7 @@ __marimo__/
208208

209209
# MyST documentation build
210210
docs/_build
211+
212+
# Jupytext sync is a tool for writing notebooks in `.ipynb` format, and syncing them to a `.md` file
213+
# https://marketplace.visualstudio.com/items?itemName=caenrigen.jupytext-sync
214+
.jupytext-sync-ipynb

0 commit comments

Comments
 (0)