Use markdown-cli to check markdown for the style errors

.github/issue_template.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD041 -->
 Hi! Thanks for using the Jupyter Docker Stacks.
 
 Please review the following guidance about how to ask questions, contribute changes, or report bugs in the Docker images maintained here.
@@ -20,7 +21,7 @@ Example: `docker run -it --rm -p 8889:8888 jupyter/all-spark-notebook:latest`
 
 Example:
 
-1. Visit http://localhost:8888
+1. Visit <http://localhost:8888>
 2. Start an R notebook
 3. ...
 

.markdownlint.yaml

@@ -0,0 +1,7 @@
+# Default state for all rules
+default: true
+
+# MD013/line-length - Line length
+MD013:
+  # Number of characters
+  line_length: 1000

.pre-commit-config.yaml

@@ -31,3 +31,8 @@ repos:
     rev: v1.5.6
     hooks:
       - id: autopep8
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.27.1
+    hooks:
+      - id: markdownlint
+        args: ['--fix']

CODE_OF_CONDUCT.md

@@ -1 +1,3 @@
+# Project `jupyter/docker-stacks` Code of Conduct
+
 Please see the [Project Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).

CONTRIBUTING.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD041 -->
+
 Thanks for contributing! Please see the
 __Contributor Guide__ section in [the documentation](https://jupyter-docker-stacks.readthedocs.io) for
 information about how to contribute

LICENSE.md

@@ -39,7 +39,7 @@ The Jupyter Development Team is the set of all contributors to the Jupyter proje
 This includes all of the Jupyter subprojects.
 
 The core team that coordinates development on GitHub can be found here:
-https://github.com/jupyter/.
+<https://github.com/jupyter/>.
 
 ## Our Copyright Policy
 

README.md

@@ -1,10 +1,10 @@
+# Jupyter Docker Stacks
+
 [![Discourse badge](https://img.shields.io/discourse/https/discourse.jupyter.org/users.svg?color=%23f37626)](https://discourse.jupyter.org/c/questions "Jupyter Discourse Q&A")
 [![Read the Docs badge](https://img.shields.io/readthedocs/jupyter-docker-stacks.svg)](https://jupyter-docker-stacks.readthedocs.io/en/latest/ "Documentation build status")
 [![DockerHub badge](https://images.microbadger.com/badges/version/jupyter/base-notebook.svg)](https://microbadger.com/images/jupyter/base-notebook "Recent tag/version of jupyter/base-notebook")
 [![Binder badget](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb "Launch a jupyter/base-notebook container on mybinder.org")
 
-# Jupyter Docker Stacks
-
 Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter)
 containing Jupyter applications and interactive computing tools.
 

all-spark-notebook/README.md

@@ -1,10 +1,10 @@
+# Jupyter Notebook Python, Scala, R, Spark Stack
+
 [![docker pulls](https://img.shields.io/docker/pulls/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
 [![docker stars](https://img.shields.io/docker/stars/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
 [![image metadata](https://images.microbadger.com/badges/image/jupyter/all-spark-notebook.svg)](https://microbadger.com/images/jupyter/all-spark-notebook "jupyter/all-spark-notebook image metadata")
 
-# Jupyter Notebook Python, Scala, R, Spark Stack
-
-GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
+GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
 to Docker Hub.
 
 Please visit the project documentation site for help using and contributing to this image and

base-notebook/README.md

@@ -1,10 +1,10 @@
+# Base Jupyter Notebook Stack
+
 [![docker pulls](https://img.shields.io/docker/pulls/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
 [![docker stars](https://img.shields.io/docker/stars/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
 [![image metadata](https://images.microbadger.com/badges/image/jupyter/base-notebook.svg)](https://microbadger.com/images/jupyter/base-notebook "jupyter/base-notebook image metadata")
 
-# Base Jupyter Notebook Stack
-
-GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
+GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
 to Docker Hub.
 
 Please visit the project documentation site for help using and contributing to this image and

datascience-notebook/README.md

@@ -1,10 +1,10 @@
+# Jupyter Notebook Data Science Stack
+
 [![docker pulls](https://img.shields.io/docker/pulls/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
 [![docker stars](https://img.shields.io/docker/stars/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
 [![image metadata](https://images.microbadger.com/badges/image/jupyter/datascience-notebook.svg)](https://microbadger.com/images/jupyter/datascience-notebook "jupyter/datascience-notebook image metadata")
 
-# Jupyter Notebook Data Science Stack
-
-GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
+GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
 to Docker Hub.
 
 Please visit the project documentation site for help using and contributing to this image and

docs/contributing/features.md

@@ -40,9 +40,11 @@ If there's agreement that the feature belongs in one or more of the core stacks:
 2. Please build the image locally before submitting a pull request. Building the image locally
    shortens the debugging cycle by taking some load off GitHub Actions, which graciously provide
    free build services for open source projects like this one. If you use `make`, call:
+
    ```bash
    make build/somestack-notebook
    ```
+
 3. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
    (PR) with your changes.
 4. Watch for GitHub to report a build success or failure for your PR on GitHub.

docs/contributing/lint.md

@@ -6,7 +6,7 @@ To integrate and enforce this process in the project lifecycle we are using **gi
 
 ## Pre-commit hook
 
-### Installation
+### Pre-commit hook installation
 
 pre-commit is a Python package that needs to be installed.
 This can be achieved by using the generic task used to install all Python development dependencies.
@@ -21,7 +21,7 @@ $ pip install pre-commit
 Then the git hooks scripts configured for the project in `.pre-commit-config.yaml` need to be installed in the local git repository.
 
 ```sh
-$ make pre-commit-install
+make pre-commit-install
 ```
 
 ### Run
@@ -32,7 +32,7 @@ However it is also possible to trigger it against all files.
 - Note: Hadolint pre-commit uses docker to run, so docker should be running while running this command.
 
 ```sh
-$ make pre-commit-all
+make pre-commit-all
 ```
 
 ## Image Lint

docs/contributing/packages.md

@@ -16,9 +16,11 @@ Please follow the process below to update a package version:
 3. Please build the image locally before submitting a pull request. Building the image locally
    shortens the debugging cycle by taking some load off GitHub Actions, which graciously provide
    free build services for open source projects like this one. If you use `make`, call:
+
    ```bash
    make build/somestack-notebook
    ```
+
 4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
    (PR) with your changes.
 5. Watch for GitHub to report a build success or failure for your PR on GitHub.

docs/contributing/stacks.md

@@ -20,7 +20,7 @@ your own path using alternative services and build tools.
 First, install [cookiecutter](https://github.com/audreyr/cookiecutter) using pip or conda:
 
 ```bash
-pip install cookiecutter   # or conda install cookiecutter
+pip install cookiecutter  # or conda install cookiecutter
 ```
 
 Run the cookiecutter command pointing to the
@@ -34,34 +34,34 @@ cookiecutter https://github.com/jupyter/cookiecutter-docker-stacks.git
 Enter a name for your new stack image. This will serve as both the git repository name and the part
 of the Docker image name after the slash.
 
-```
+```lang-none
 stack_name [my-jupyter-stack]:
 ```
 
 Enter the user or organization name under which this stack will reside on Docker Cloud / Hub. You
 must have access to manage this Docker Cloud org to push images here and set up automated
 builds.
 
-```
+```lang-none
 stack_org [my-project]:
 ```
 
 Select an image from the jupyter/docker-stacks project that will serve as the base for your new
 image.
 
-```
+```lang-none
 stack_base_image [jupyter/base-notebook]:
 ```
 
 Enter a longer description of the stack for your README.
 
-```
+```lang-none
 stack_description [my-jupyter-stack is a community maintained Jupyter Docker Stack image]:
 ```
 
 Initialize your project as a Git repository and push it to GitHub.
 
-```
+```bash
 cd <stack_name you chose>
 
 git init

docs/contributing/tests.md

@@ -23,10 +23,12 @@ Please follow the process below to add new tests:
 2. If your test should run against a single image, add your test code to one of the modules in
    `some-notebook/test/` or create a new module.
 3. Build one or more images you intend to test and run the tests locally. If you use `make`, call:
+
    ```bash
    make build/somestack-notebook
    make test/somestack-notebook
    ```
+
 4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
    (PR) with your changes.
 5. Watch for GitHub to report a build success or failure for your PR on GitHub.

docs/contributing/translations.md

@@ -3,5 +3,5 @@
 We are delighted when members of the Jupyter community want to help translate these documentation pages to other languages. If you're interested, please visit links below below to join our team on [Transifex](https://transifex.com) and to start creating, reviewing, and updating translations of the Jupyter Docker Stacks documentation.
 
 1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page.
-2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1 after creating your account and request to join the project.
+2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1> after creating your account and request to join the project.
 3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation.

docs/maintaining/tasks.md

@@ -62,9 +62,9 @@ When there's a new stack definition, do the following before merging the PR with
 
 ## Adding a New Maintainer Account
 
-1. Visit https://cloud.docker.com/app/jupyter/team/stacks/users
+1. Visit <https://cloud.docker.com/app/jupyter/team/stacks/users>
 2. Add the maintainer's Docker Cloud username.
-3. Visit https://github.com/orgs/jupyter/teams/docker-image-maintainers/members
+3. Visit <https://github.com/orgs/jupyter/teams/docker-image-maintainers/members>
 4. Add the maintainer's GitHub username.
 
 ## Pushing a Build Manually
@@ -80,23 +80,23 @@ If automated builds on Docker Cloud have got you down, do the following to push
 
 First enable translation on Transifex:
 
-1. Visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1/languages/
+1. Visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1/languages/>.
 2. Click _Edit Languages_ in the top right.
 3. Select the language from the dropdown.
 4. Click _Apply_.
 
 Then setup a subproject on ReadTheDocs for the language:
 
-1. Visit https://readthedocs.org/dashboard/import/manual/
+1. Visit <https://readthedocs.org/dashboard/import/manual/>.
 2. Enter _jupyter-docker-stacks-language_abbreviation_ for the project name.
-3. Enter https://github.com/jupyter/docker-stacks for the URL.
+3. Enter <https://github.com/jupyter/docker-stacks> for the URL.
 4. Check _Edit advanced project options_.
 5. Click _Next_.
 6. Select the _Language_ from the dropdown on the next screen.
 7. Click _Finish_.
 
 Finally link the new language subproject to the top level doc project:
 
-1. Visit https://readthedocs.org/dashboard/jupyter-docker-stacks/translations/
+1. Visit <https://readthedocs.org/dashboard/jupyter-docker-stacks/translations/>.
 2. Select the subproject you created from the _Project_ dropdown.
 3. Click _Add_.

docs/using/recipes.md

@@ -166,11 +166,13 @@ ENTRYPOINT ["jupyter", "lab", "--ip=0.0.0.0", "--allow-root"]
 ```
 
 And build the image as:
+
 ```bash
 docker build -t jupyter/scipy-dasklabextension:latest .
 ```
 
 Once built, run using the command:
+
 ```bash
 docker run -it --rm -p 8888:8888 -p 8787:8787 jupyter/scipy-dasklabextension:latest
 ```
@@ -273,6 +275,7 @@ ARG BASE_CONTAINER=ubuntu:focal-20200423@sha256:238e696992ba9913d24cfc3727034985
 ```
 
 For Ubuntu 18.04 (bionic) and earlier, you may also require to workaround for a mandb bug, which was fixed in mandb >= 2.8.6.1:
+
 ```dockerfile
 # https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=8197d7824f814c5d4b992b4c8730b5b0f7ec589a
 # http://launchpadlibrarian.net/435841763/man-db_2.8.5-2_2.8.6-1.diff.gz

docs/using/running.md

@@ -13,8 +13,8 @@ You can launch a local Docker container from the Jupyter Docker Stacks using the
 
 **Example 1** This command pulls the `jupyter/scipy-notebook` image tagged `2c80cf3537ca` from Docker Hub if it is not already present on the local host. It then starts a container running a Jupyter Notebook server and exposes the server on host port 8888. The server logs appear in the terminal and include a URL to the notebook server.
 
-```
-docker run -p 8888:8888 jupyter/scipy-notebook:2c80cf3537ca
+```bash
+$ docker run -p 8888:8888 jupyter/scipy-notebook:2c80cf3537ca
 
 Executing the command: jupyter notebook
 [I 15:33:00.567 NotebookApp] Writing notebook server cookie secret to /home/jovyan/.local/share/jupyter/runtime/notebook_cookie_secret
@@ -35,27 +35,27 @@ Executing the command: jupyter notebook
 
 Pressing `Ctrl-C` shuts down the notebook server but leaves the container intact on disk for later restart or permanent deletion using commands like the following:
 
-```
+```bash
 # list containers
-docker ps -a
+$ docker ps -a
 CONTAINER ID        IMAGE                   COMMAND                  CREATED    STATUS                      PORTS               NAMES
 d67fe77f1a84        jupyter/base-notebook   "tini -- start-noteb…"   44 seconds ago    Exited (0) 39 seconds ago                       cocky_mirzakhani
 
 # start the stopped container
-docker start -a d67fe77f1a84
+$ docker start -a d67fe77f1a84
 Executing the command: jupyter notebook
 [W 16:45:02.020 NotebookApp] WARNING: The notebook server is listening on all IP addresses and not using encryption. This is not recommended.
 ...
 
 # remove the stopped container
-docker rm d67fe77f1a84
+$ docker rm d67fe77f1a84
 d67fe77f1a84
 ```
 
 **Example 2** This command pulls the `jupyter/r-notebook` image tagged `e5c5a7d3e52d` from Docker Hub if it is not already present on the local host. It then starts a container running a Jupyter Notebook server and exposes the server on host port 10000. The server logs appear in the terminal and include a URL to the notebook server, but with the internal container port (8888) instead of the the correct host port (10000).
 
-```
-docker run --rm -p 10000:8888 -v "$PWD":/home/jovyan/work jupyter/r-notebook:e5c5a7d3e52d
+```bash
+$ docker run --rm -p 10000:8888 -v "$PWD":/home/jovyan/work jupyter/r-notebook:e5c5a7d3e52d
 
 Executing the command: jupyter notebook
 [I 19:31:09.573 NotebookApp] Writing notebook server cookie secret to /home/jovyan/.local/share/jupyter/runtime/notebook_cookie_secret
@@ -78,29 +78,29 @@ Pressing `Ctrl-C` shuts down the notebook server and immediately destroys the Do
 
 **Example 3** This command pulls the `jupyter/all-spark-notebook` image currently tagged `latest` from Docker Hub if an image tagged `latest` is not already present on the local host. It then starts a container named `notebook` running a JupyterLab server and exposes the server on a randomly selected port.
 
-```
+```bash
 docker run -d -P --name notebook jupyter/all-spark-notebook
 ```
 
 The assigned port and notebook server token are visible using other Docker commands.
 
-```
+```bash
 # get the random host port assigned to the container port 8888
-docker port notebook 8888
+$ docker port notebook 8888
 0.0.0.0:32769
 
 # get the notebook token from the logs
-docker logs --tail 3 notebook
+$ docker logs --tail 3 notebook
     Copy/paste this URL into your browser when you connect for the first time,
     to login with a token:
         http://localhost:8888/?token=15914ca95f495075c0aa7d0e060f1a78b6d94f70ea373b00
 ```
 
-Together, the URL to visit on the host machine to access the server in this case is http://localhost:32769?token=15914ca95f495075c0aa7d0e060f1a78b6d94f70ea373b00.
+Together, the URL to visit on the host machine to access the server in this case is <http://localhost:32769?token=15914ca95f495075c0aa7d0e060f1a78b6d94f70ea373b00>.
 
 The container runs in the background until stopped and/or removed by additional Docker commands.
 
-```
+```bash
 # stop the container
 docker stop notebook
 notebook