Switch to mkdocs from Hugo (#926)

Closes #908
ponylang · Feb 12, 2024 · 06585be · 06585be
1 parent 1ebf407
commit 06585be
Show file tree

Hide file tree

Showing 412 changed files with 3,792 additions and 4,744 deletions.
diff --git a/.github/workflows/verify-site-builds.yml b/.github/workflows/verify-site-builds.yml
@@ -0,0 +1,31 @@
+name: Verify site builds
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 2 * * *'
+
+jobs:
+  test:
+    name: Verify site builds
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/[email protected]
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+        env:
+          INSIDERS_PAT: ${{ secrets.MATERIAL_INSIDERS_ACCESS }}
+      - name: Build site
+        run: mkdocs build
+      - name: Send alert on failure
+        if: ${{ failure() }}
+        uses: zulip/github-actions-zulip/send-message@b62d5a0e48a4d984ea4fce5dd65ba691963d4db4
+        with:
+          api-key: ${{ secrets.ZULIP_SCHEDULED_JOB_FAILURE_API_KEY }}
+          email: ${{ secrets.ZULIP_SCHEDULED_JOB_FAILURE_EMAIL }}
+          organization-url: 'https://ponylang.zulipchat.com/'
+          to: notifications
+          type: stream
+          topic: ${{ github.repository }} scheduled job failure
+          content: ${{ github.server_url}}/${{ github.repository }}/actions/runs/${{ github.run_id }} failed.
diff --git a/.gitignore b/.gitignore
@@ -62,7 +62,5 @@ Temporary Items
 # Linux trash folder which might appear on any partition or disk
 .Trash-*
 
-
-### Hugo ###
-hugo.exe
-/public/
+### mkdocs ##
+/site/
diff --git a/.spellcheck.yml b/.spellcheck.yml
@@ -37,5 +37,5 @@ matrix:
       - 'a'
 
   sources:
-  - 'content/**/*.md'
+  - 'docs/**/*.md'
   default_encoding: utf-8
diff --git a/.spelling-wordlist.txt b/.spelling-wordlist.txt
@@ -30,6 +30,7 @@ Athaydes
 atomics
 aturley
 autocomplete
+autogenerated
 automagically
 AVX
 backpressure
@@ -258,6 +259,7 @@ Liétar
 Liétar's
 linkable
 LINQ
+linter
 Linux
 LLDB
 LLVM

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,10 +6,7 @@ Please note, that by submitting any content to the Pony Tutorial book you are ag
 
 ## Hugo
 
-The Pony website is generated using [Hugo]: a static website generator. If you are making larger changes to the site, you will need to install Hugo locally to verify your changes are working.
-
-Because the site is deploying using a remote server, you should make sure you are developing using whatever version the deploy server is currently running.
-The site is currently built for production deploy using v0.24.1.
+The Pony website is generated using [`mkdocs`]: a static website generator. If you are making larger changes to the site, you will need to install `mkdocs` locally to verify your changes are working.
 
 ## Ponylang.io hosting
 
@@ -23,18 +20,18 @@ Netlify offers "deploy previews" that allow you to view the results of a PR befo
 
 To see the preview, on the PR page select `Show all checks` and then click `Details` next to `deploy/netlify - Deploy preview is ready!`
 
-## Developing locally with Hugo
+## Developing locally with mkdocs
 
-To do larger changes, you'll want to install Hugo locally so you can test your changes. As of now, we are using Hugo v0.16. For detailed instructions on using [Hugo], please refer to its website.
+To do larger changes, you'll want to install mkdocs locally so you can test your changes. For detailed instructions on using [mkdocs], please refer to its website.
 
-For simpler tasks, once you have Hugo installed, you should be able to:
+For simpler tasks, once you have mkdocs installed, you should be able to:
 
 ```bash
 cd ponylang.github.io
-hugo server
+mkdocs serve
 ```
 
-Which will start up a local webserver that will serve the Ponylang website on `http://localhost:1313`. Generated content will be placed in the `public` folder which is ignored by git. Do not check in any generated content to the `source` branch.
+Which will start up a local webserver that will serve the Ponylang website on `http://localhost:8080`.
 
 Once you are happy with your changes, commit then and submit a PR. Before doing that, please read the following 'How to submit a pull request' section.
 
@@ -55,5 +52,5 @@ If your PR is for a single logical change (which is should be) but spans multipl
 
 Favor relative links for any content on ponylang.io. Absolute links that point to `https://www.ponylang.io` don't play well with Netlify deploy previews. Absolute links will redirect you off the preview website and onto the live website. For this reason, relative links are preferred.
 
-[Hugo]: https://gohugo.io
+[mkdocs]: https://www.mkdocs.org/
 [Netlify]: https://www.netlify.com/.
diff --git a/archetypes/default.md b/archetypes/default.md
diff --git a/archetypes/lwip.md b/archetypes/lwip.md
diff --git a/archetypes/release.md b/archetypes/release.md
diff --git a/content/blog/_index.md b/content/blog/_index.md
diff --git a/content/community/talks.md b/content/community/talks.md
diff --git a/content/index.md b/content/index.md
diff --git a/data/author/codecabc.json b/data/author/codecabc.json
diff --git a/data/author/colinobrien.json b/data/author/colinobrien.json
diff --git a/data/author/dipinhora.json b/data/author/dipinhora.json
diff --git a/data/author/jdhorwitz.json b/data/author/jdhorwitz.json
diff --git a/data/author/kevinhoffman.json b/data/author/kevinhoffman.json
diff --git a/data/author/mwahl.json b/data/author/mwahl.json
diff --git a/data/author/red.json b/data/author/red.json
diff --git a/data/author/ryan.json b/data/author/ryan.json
diff --git a/data/author/seantallen.json b/data/author/seantallen.json
diff --git a/data/author/sylvan.json b/data/author/sylvan.json
diff --git a/data/author/theobutler.json b/data/author/theobutler.json
diff --git a/data/recent-talks.json b/data/recent-talks.json
diff --git a/static/CNAME → docs/CNAME b/static/CNAME → docs/CNAME
diff --git a/static/README.md → docs/README.md b/static/README.md → docs/README.md
diff --git a/static/_redirects → docs/_redirects b/static/_redirects → docs/_redirects
@@ -69,3 +69,6 @@ https://ponylang.org/* https://www.ponylang.io/:splat 301!
 # as that is most likely what someone wanted
 /categories/release/ https://github.com/ponylang/ponyc/releases 301!
 /categories/release/index.xml https://github.com/ponylang/ponyc/releases.atom 301!
+
+## send the blog categories to the new mkdocs location
+/categories/* /blog/categories/:splat 301!
diff --git a/static/avatars/codecabc.png → docs/assets/avatars/codecabc.png b/static/avatars/codecabc.png → docs/assets/avatars/codecabc.png
diff --git a/static/avatars/colinobrien.png → docs/assets/avatars/colinobrien.png b/static/avatars/colinobrien.png → docs/assets/avatars/colinobrien.png
diff --git a/static/avatars/default.png → docs/assets/avatars/default.png b/static/avatars/default.png → docs/assets/avatars/default.png
diff --git a/static/avatars/dipinhora.jpg → docs/assets/avatars/dipinhora.jpg b/static/avatars/dipinhora.jpg → docs/assets/avatars/dipinhora.jpg
diff --git a/static/avatars/jdhorwitz.png → docs/assets/avatars/jdhorwitz.png b/static/avatars/jdhorwitz.png → docs/assets/avatars/jdhorwitz.png
diff --git a/static/avatars/kevinhoffman.png → docs/assets/avatars/kevinhoffman.png b/static/avatars/kevinhoffman.png → docs/assets/avatars/kevinhoffman.png
diff --git a/static/avatars/mwahl.png → docs/assets/avatars/mwahl.png b/static/avatars/mwahl.png → docs/assets/avatars/mwahl.png
diff --git a/static/avatars/seantallen.png → docs/assets/avatars/seantallen.png b/static/avatars/seantallen.png → docs/assets/avatars/seantallen.png
diff --git a/static/avatars/sylvan.png → docs/assets/avatars/sylvan.png b/static/avatars/sylvan.png → docs/assets/avatars/sylvan.png
diff --git a/static/avatars/theobutler.png → docs/assets/avatars/theobutler.png b/static/avatars/theobutler.png → docs/assets/avatars/theobutler.png
diff --git a/static/images/logo.png → docs/assets/logo.png b/static/images/logo.png → docs/assets/logo.png
diff --git a/static/benchmarks_all.pdf → docs/benchmarks_all.pdf b/static/benchmarks_all.pdf → docs/benchmarks_all.pdf