Switch to Markdown (#103)

* Fix unmatched paragraph tags

* Capitalize Higher Order Functions title consistently

* Change apostrophes in text to curved closing quotes

* Write ellipsis as ... in markdown and as single character in html

* Write em dash as a single character in html

* Adjust HTML whitespace to make automatic replacement easier

* Replace single quotes with ' in code blocks

* Replace double quotes with " in code blocks

* Change double quotes in HTML text to curved double quote characters

* Change " to literal double quote in inline code in 1 location

* Replace raw characters with entities (e.g. <) in code blocks

* Align use of no-break space U+00A0 and   in markdown and HTML

* Change <a name...> anchors to id attributes on h2 tags

* Add id attributes to heading tags that do not have them

* Change order of attributes in img tags

* Delete px from img tag width and height attributes

* Replace newline with space in img alt attributes

* Change license link rel attribute from nofollow to license and adjust its position

* Post-process pandoc output to add chapters class to chapter list

* Change HTML chapter list to match markdown: remove enclosing paragraph and add type attribute

* Add upper margin to chapter list to restore the spacing from the removed <p> tag

* Change <b> and <em> tags to <strong> in HTML

* Change <i> tags to <em> in HTML

* Change hintbox tag from <p> to <div> in one location

* Put <p> tag around contents of hintboxes

* Change <span> tags to <code> and adjust CSS for inline code

* Do all remaining changes to replace existing HTML with markdown-generated HTML

* add github pages workflow

Signed-off-by: Artem Pelenitsyn <[email protected]>

* CI: make github pages workflow regenerate HTML from Markdown

Removed duplicate checkout action in deploy workflow.

* change em -> strong on index.html to preserve original formatting

* fix formatting of an error message

* Adjust alignment of snippet

* Adjust style to make sure that inline snippet are line breakable (line
wrap)

* remove generated files (including docs/*.html except index), clean up generate.sh, add .gitignore & Makefile

* clean up assets: remove dup CSS, move top-level sh-scripts under sh/Scripts

* responsive design for mobile (manually cherry-pick 7c5423a from #64)

---------

Signed-off-by: Artem Pelenitsyn <[email protected]>
Co-authored-by: Gregory Cox <[email protected]>
Co-authored-by: Pier-Luc Caron St-Pierre <[email protected]>

Author: 3 people

.github/workflows/deploy-pages.yml

@@ -12,6 +12,11 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pandoc
+        run: |
+          sudo apt install pandoc
+      - name: Generate HTML from Markdown
+        run: make
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4
         with:

.gitignore

@@ -0,0 +1,4 @@
+docs/*.html
+!docs/index.html
+
+.DS_Store

Makefile

@@ -0,0 +1,13 @@
+##
+# Build LYAH web site from Markdown sources using Pandoc and sed
+#
+
+all: site
+
+site:
+	cd markdown && ./generate.sh
+
+clean:
+	find ./docs -name '*.html' -not -name 'index.html' -delete
+
+# end

README.md

@@ -22,11 +22,13 @@ The whole thing is completely free to read online, but the original is also avai
 - [ ] refactor web code
 - [ ] make UI more modern (whilst retaining as much of the original "feel" as possible)
 - [x] make content pages mobile-friendly (*still needs work)
-- [ ] make homepage mobile-friendly
+- [ ] make index page mobile-friendly
 - [x] prepare "content edit request" interface on GitHub
 - [ ] add exercises
 - [ ] update content (just overall, the outdated parts)
 
+For some of these points, there are more focused issues on GitHub.
+
 Don't forget to star the GitHub repository if you like it! 🙂
 
 ## Discussion