Merge pull request #39 from openedx/nedbat/narrow

fix: keep text narrow to avoid too-wide display on GitHub
openedx-unsupported · Sep 14, 2023 · a89eefd · a89eefd
2 parents 9505dfa + 17ed202
commit a89eefd
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 12 deletions.
diff --git a/README.rst b/README.rst
@@ -8,10 +8,6 @@ welcome.
 
 The cheatsheet: `mdrst.rst`_.
 
-I started by editing a document with side-by-side examples of both Markdown and
-RST, but it was difficult to edit, and difficult to know that I had gotten all
-of the details right.
-
 In this repo are two files: `md.md`_ and `rst.rst`_.  They have parallel
 heading structures, each showing how their format represents each construct.
 Together, they produce `mdrst.rst`_, which shows the examples side-by-side.

diff --git a/md.md b/md.md
@@ -20,7 +20,7 @@ Look at this output:
 
 ```
 $ ls /usr/
-bin        lib        libexec    local      sbin       share
+bin        lib        libexec
 ```
 
 Look at this code:
@@ -117,9 +117,10 @@ Markdown has no specialized syntax for notes.
 
 ### Footnotes
 
-Extended version of markdown does support footnotes[^1].
+Extended Markdown supports footnotes[^1].
 
-[^1]: The footnote will mostly be displayed in the bottom no matter where you define it, hence _the name_.
+[^1]: The footnote will mostly be displayed in the bottom
+no matter where you define it, hence _the name_.
 
 ### Warnings
 

diff --git a/mdrst.rst b/mdrst.rst
@@ -81,7 +81,7 @@ Basic Stuff
 
           ```
           $ ls /usr/
-          bin        lib        libexec    local      sbin       share
+          bin        lib        libexec
           ```
 
           Look at this code:
@@ -99,7 +99,7 @@ Basic Stuff
           Look at this output::
 
              $ ls /usr/
-             bin        lib        libexec    local      sbin       share
+             bin        lib        libexec
 
           Look at this code:
 
@@ -368,9 +368,10 @@ Notes etc
    * - Footnotes
      - ::
 
-          Extended version of markdown does support footnotes[^1].
+          Extended Markdown supports footnotes[^1].
 
-          [^1]: The footnote will mostly be displayed in the bottom no matter where you define it, hence _the name_.
+          [^1]: The footnote will mostly be displayed in the bottom
+          no matter where you define it, hence _the name_.
 
      - ::
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 markdown2
 docutils
 edx_lint
+pygments
diff --git a/rst.rst b/rst.rst
@@ -29,7 +29,7 @@ Code blocks
 Look at this output::
 
    $ ls /usr/
-   bin        lib        libexec    local      sbin       share
+   bin        lib        libexec
 
 Look at this code: