Use mdformat instead of prettier (#1022)

Author: blink1073

.pre-commit-config.yaml

@@ -41,10 +41,10 @@ repos:
       - id: validate-pyproject
         stages: [manual]
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.7.1
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.16
     hooks:
-      - id: prettier
+      - id: mdformat
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v2.38.2

CHANGELOG.md

@@ -56,5 +56,7 @@ change to one of the Jupyter repositories.
 With this in mind, the following banner should be used in any source code file
 to indicate the copyright and license terms:
 
-    # Copyright (c) Jupyter Development Team.
-    # Distributed under the terms of the Modified BSD License.
+```
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+```

COPYING.md

@@ -12,7 +12,9 @@ For more information, read our [documentation here](http://jupyter-server.readth
 To install the latest release locally, make sure you have
 [pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
 
-    pip install jupyter_server
+```
+pip install jupyter_server
+```
 
 Jupyter Server currently supports Python>=3.6 on Linux, OSX and Windows.
 
@@ -30,7 +32,9 @@ To see the changes between releases, checkout the [CHANGELOG](https://github.com
 
 Launch with:
 
-    jupyter server
+```
+jupyter server
+```
 
 ### Testing
 

README.md

@@ -3,8 +3,8 @@
 This folder contains the following examples:
 
 1. a "read-only" Jupyter Notebook Server
-2. a read/write Server without the ability to execute code on kernels.
-3. a "temporary notebook server", i.e. read and execute notebooks but cannot save/write files.
+1. a read/write Server without the ability to execute code on kernels.
+1. a "temporary notebook server", i.e. read and execute notebooks but cannot save/write files.
 
 ## How does it work?
 
@@ -45,27 +45,27 @@ In the `jupyter_nbclassic_readonly_config.py`
 
    pip install nbclassic
 
-2. Navigate to the jupyter_authorized_server `examples/` folder.
+1. Navigate to the jupyter_authorized_server `examples/` folder.
 
-3. Launch nbclassic and load `jupyter_nbclassic_readonly_config.py`:
+1. Launch nbclassic and load `jupyter_nbclassic_readonly_config.py`:
 
    jupyter nbclassic --config=jupyter_nbclassic_readonly_config.py
 
-4. Try creating a notebook, running a notebook in a cell, etc. You should see a `403: Forbidden` error.
+1. Try creating a notebook, running a notebook in a cell, etc. You should see a `403: Forbidden` error.
 
 ### Read+Write example
 
 1. Install nbclassic using `pip`.
 
    pip install nbclassic
 
-2. Navigate to the jupyter_authorized_server `examples/` folder.
+1. Navigate to the jupyter_authorized_server `examples/` folder.
 
-3. Launch nbclassic and load `jupyter_nbclassic_rw_config.py`:
+1. Launch nbclassic and load `jupyter_nbclassic_rw_config.py`:
 
    jupyter nbclassic --config=jupyter_nbclassic_rw_config.py
 
-4. Try running a cell in a notebook. You should see a `403: Forbidden` error.
+1. Try running a cell in a notebook. You should see a `403: Forbidden` error.
 
 ### Temporary notebook server example
 
@@ -75,10 +75,10 @@ This configuration allows everything except saving files.
 
    pip install nbclassic
 
-2. Navigate to the jupyter_authorized_server `examples/` folder.
+1. Navigate to the jupyter_authorized_server `examples/` folder.
 
-3. Launch nbclassic and load `jupyter_temporary_config.py`:
+1. Launch nbclassic and load `jupyter_temporary_config.py`:
 
    jupyter nbclassic --config=jupyter_temporary_config.py
 
-4. Edit a notebook, run a cell, etc. Everything works fine. Then try to save your changes... you should see a `403: Forbidden` error.
+1. Edit a notebook, run a cell, etc. Everything works fine. Then try to save your changes... you should see a `403: Forbidden` error.

examples/authorization/README.md

@@ -29,7 +29,9 @@ if running Ubuntu 14, you should set environment variable `LANGUAGE="xx_XX"`.
 
 **All i18n-related commands are done from the related directory :**
 
-    cd notebook/i18n/
+```
+cd notebook/i18n/
+```
 
 ### Message extraction
 
@@ -69,7 +71,9 @@ pybabel compile -D nbui -f -l ${LANG} -i ${LANG}/LC_MESSAGES/nbui.po -o ${LANG}/
 
 _nbjs.po_ needs to be converted to JSON for use within the JavaScript code, with _po2json_, as follows:
 
-    po2json -p -F -f jed1.x -d nbjs ${LANG}/LC_MESSAGES/nbjs.po ${LANG}/LC_MESSAGES/nbjs.json
+```
+po2json -p -F -f jed1.x -d nbjs ${LANG}/LC_MESSAGES/nbjs.po ${LANG}/LC_MESSAGES/nbjs.json
+```
 
 When new languages get added, their language codes should be added to _notebook/i18n/nbjs.json_
 under the `supported_languages` element.
@@ -111,21 +115,25 @@ to handle these cases properly.
 
 ### Known issues and future evolutions
 
-1.  Right now there are two different places where the desired language is set. At startup time, the Jupyter console's messages pay attention to the setting of the `${LANG}` environment variable
-    as set in the shell at startup time. Unfortunately, this is also the time where the Jinja2
-    environment is set up, which means that the template stuff will always come from this setting.
-    We really want to be paying attention to the browser's settings for the stuff that happens in the
-    browser, so we need to be able to retrieve this information after the browser is started and somehow
-    communicate this back to Jinja2. So far, I haven't yet figured out how to do this, which means that if the ${LANG} at startup doesn't match the browser's settings, you could potentially get a mix
-    of languages in the UI ( never a good thing ).
-
-2.  We will need to decide if console messages should be translatable, and enable them if desired.
-3.  The keyboard shortcut editor was implemented after the i18n work was completed, so that portion
-    does not have translation support at this time.
-4.  Babel's documentation has instructions on how to integrate messages extraction
-    into your _setup.py_ so that eventually we can just do:
-
-        ./setup.py extract_messages
+1. Right now there are two different places where the desired language is set. At startup time, the Jupyter console's messages pay attention to the setting of the `${LANG}` environment variable
+   as set in the shell at startup time. Unfortunately, this is also the time where the Jinja2
+   environment is set up, which means that the template stuff will always come from this setting.
+   We really want to be paying attention to the browser's settings for the stuff that happens in the
+   browser, so we need to be able to retrieve this information after the browser is started and somehow
+   communicate this back to Jinja2. So far, I haven't yet figured out how to do this, which means that if the ${LANG} at startup doesn't match the browser's settings, you could potentially get a mix
+   of languages in the UI ( never a good thing ).
+
+1. We will need to decide if console messages should be translatable, and enable them if desired.
+
+1. The keyboard shortcut editor was implemented after the i18n work was completed, so that portion
+   does not have translation support at this time.
+
+1. Babel's documentation has instructions on how to integrate messages extraction
+   into your _setup.py_ so that eventually we can just do:
+
+   ```
+   ./setup.py extract_messages
+   ```
 
 I hope to get this working at some point in the near future. 5. The conversions from `.po` to `.mo` probably can and should be done using `setup.py install`.