Add pre-commit (#1)

* Add pre-commit

* Rename file

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix typo

---------

Co-authored-by: Qiusheng Wu <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v5.0.0
+      hooks:
+          - id: check-toml
+          - id: check-yaml
+          - id: end-of-file-fixer
+            types: [python]
+          - id: trailing-whitespace
+          - id: requirements-txt-fixer
+          - id: check-added-large-files
+            args: ["--maxkb=500"]
+
+    - repo: https://github.com/psf/black
+      rev: 24.10.0
+      hooks:
+          - id: black-jupyter
+
+    - repo: https://github.com/codespell-project/codespell
+      rev: v2.3.0
+      hooks:
+          - id: codespell
+            args:
+                [
+                    "--ignore-words-list=aci,acount,acounts,fallow,ges,hart,hist,nd,ned,ois,wqs,watermask,tre,mape",
+                    "--skip=*.csv,*.geojson,*.json,*.yml*.js,*.html,*cff,*.pdf",
+                ]
+
+    - repo: https://github.com/kynan/nbstripout
+      rev: 0.8.1
+      hooks:
+          - id: nbstripout

01-paper.md

@@ -51,7 +51,7 @@ MyST is focused on scientific writing, and ensuring that citations are first cla
 ![](./images/citations.png)
 **Figure 1**: Citations are rendered with a popup directly inline.
 
-MyST aims to show as much information in context as possible, for example, Figure 2 shows a reading experience for a referenced equation: you can immediately **click on the reference**, see the equation, all without loosing any context -- ultimately saving you time. Head _et al._ (2021) found that these ideas both improved the overall reading experience of articles as well as allowed researchers to answer questions about an article **26% faster** when compared to a traditional PDF!
+MyST aims to show as much information in context as possible, for example, Figure 2 shows a reading experience for a referenced equation: you can immediately **click on the reference**, see the equation, all without losing any context -- ultimately saving you time. Head _et al._ (2021) found that these ideas both improved the overall reading experience of articles as well as allowed researchers to answer questions about an article **26% faster** when compared to a traditional PDF!
 
 ![](./images/equations.gif)
 **Figure 2**: In context cross-references improve the reading experience.

requirements.txt

@@ -1,8 +1,8 @@
 # To execute the code in our notebook
 altair
-matplotlib
-numpy
-vega_datasets
 
 # To interactively browser Jupyter content with MyST
 jupyterlab_myst
+matplotlib
+numpy
+vega_datasets