Skip to content

Commit 59c973d

Browse files
authored
Merge pull request #1277 from mathbunnyru/asalikhov/fix_markdown
Use `markdown-cli` to check markdown for the style errors
2 parents 696d48c + a3d9bb8 commit 59c973d

File tree

30 files changed

+144
-128
lines changed

30 files changed

+144
-128
lines changed

.github/issue_template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD041 -->
12
Hi! Thanks for using the Jupyter Docker Stacks.
23

34
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`
2021

2122
Example:
2223

23-
1. Visit http://localhost:8888
24+
1. Visit <http://localhost:8888>
2425
2. Start an R notebook
2526
3. ...
2627

.markdownlint.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Default state for all rules
2+
default: true
3+
4+
# MD013/line-length - Line length
5+
MD013:
6+
# Number of characters
7+
line_length: 1000

.pre-commit-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,8 @@ repos:
3131
rev: v1.5.6
3232
hooks:
3333
- id: autopep8
34+
- repo: https://github.com/igorshubovych/markdownlint-cli
35+
rev: v0.27.1
36+
hooks:
37+
- id: markdownlint
38+
args: ['--fix']

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
# Project `jupyter/docker-stacks` Code of Conduct
2+
13
Please see the [Project Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- markdownlint-disable MD041 -->
2+
13
Thanks for contributing! Please see the
24
__Contributor Guide__ section in [the documentation](https://jupyter-docker-stacks.readthedocs.io) for
35
information about how to contribute

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The Jupyter Development Team is the set of all contributors to the Jupyter proje
3939
This includes all of the Jupyter subprojects.
4040

4141
The core team that coordinates development on GitHub can be found here:
42-
https://github.com/jupyter/.
42+
<https://github.com/jupyter/>.
4343

4444
## Our Copyright Policy
4545

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
# Jupyter Docker Stacks
2+
13
[![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")
24
[![Read the Docs badge](https://img.shields.io/readthedocs/jupyter-docker-stacks.svg)](https://jupyter-docker-stacks.readthedocs.io/en/latest/ "Documentation build status")
35
[![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")
46
[![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")
57

6-
# Jupyter Docker Stacks
7-
88
Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter)
99
containing Jupyter applications and interactive computing tools.
1010

all-spark-notebook/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
# Jupyter Notebook Python, Scala, R, Spark Stack
2+
13
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
24
[![docker stars](https://img.shields.io/docker/stars/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
35
[![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")
46

5-
# Jupyter Notebook Python, Scala, R, Spark Stack
6-
7-
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
7+
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
88
to Docker Hub.
99

1010
Please visit the project documentation site for help using and contributing to this image and

base-notebook/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
# Base Jupyter Notebook Stack
2+
13
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
24
[![docker stars](https://img.shields.io/docker/stars/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
35
[![image metadata](https://images.microbadger.com/badges/image/jupyter/base-notebook.svg)](https://microbadger.com/images/jupyter/base-notebook "jupyter/base-notebook image metadata")
46

5-
# Base Jupyter Notebook Stack
6-
7-
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
7+
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
88
to Docker Hub.
99

1010
Please visit the project documentation site for help using and contributing to this image and

datascience-notebook/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
# Jupyter Notebook Data Science Stack
2+
13
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
24
[![docker stars](https://img.shields.io/docker/stars/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
35
[![image metadata](https://images.microbadger.com/badges/image/jupyter/datascience-notebook.svg)](https://microbadger.com/images/jupyter/datascience-notebook "jupyter/datascience-notebook image metadata")
46

5-
# Jupyter Notebook Data Science Stack
6-
7-
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
7+
GitHub Actions in the <https://github.com/jupyter/docker-stacks> project builds and pushes this image
88
to Docker Hub.
99

1010
Please visit the project documentation site for help using and contributing to this image and

0 commit comments

Comments
 (0)