Update website

.github/workflows/markdownlint_check.yml

@@ -0,0 +1,20 @@
+name: Markdownlint Check
+
+# This action works with pull requests and pushes on the main branch
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+
+jobs:
+  lint:
+    name: Markdownlint Check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: DavidAnson/markdownlint-cli2-action@v19
+      with:
+        config: './.markdownlint.yaml'
+        globs: |
+          **/*.md

.github/workflows/prettier_check.yml

@@ -0,0 +1,30 @@
+name: Prettier Check
+
+# This action works with pull requests and pushes on the main branch
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  prettier:
+    name: Prettier Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Run Prettier
+        id: prettier-run
+        uses: rutajdash/prettier-cli-action@v1.0.0
+        with:
+          config_path: ./.prettierrc
+
+      # This step only runs if prettier finds errors causing the previous step to fail
+      # This steps lists the files where errors were found
+      - name: Prettier Output
+        if: ${{ failure() }}
+        shell: bash
+        run: |
+          echo "The following files are not formatted:"
+          echo "${{steps.prettier-run.outputs.prettier_output}}"

.gitignore

@@ -1,3 +1,4 @@
 public/
 pagefind
 .hugo_build.lock
+node_modules

.markdownlint.yaml

@@ -0,0 +1,10 @@
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
+line-length:
+  line_length: 120
+  tables: false
+
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
+no-inline-html: false
+
+# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md036.md
+no-emphasis-as-heading: false

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "printWidth": 120,
+  "proseWrap": "always",
+  "plugins": ["prettier-plugin-go-template"],
+  "overrides": [
+    {
+      "files": ["*.html"],
+      "options": {
+        "parser": "go-template"
+      }
+    }
+  ]
+}

README.md

@@ -1,51 +1,165 @@
-OSUOSL Hugo Static Site
-=======================
+# OSUOSL Hugo Static Site
 
 Migrated from our static [Pelican site](https://github.com/osuosl/osuosl-pelican)
 
-Based off of the Mainroad theme on https://github.com/Vimux/Mainroad and the previous [OSL theme](https://github.com/osuosl/dougfir-pelican-theme)
+Based off of the [Mainroad theme](https://github.com/Vimux/Mainroad) and the previous
+[OSL theme](https://github.com/osuosl/dougfir-pelican-theme)
 
-Changes From Pelican
---------------------
+## Development
 
-Hugo uses markdown to write its pages, thus the front matter of a page will look slightly different.
+### Prerequisites
 
-The author of a page should be included as an array of ``authors`` within the front matter:
+Read the [Hugo getting started guide's prerequisite list](https://gohugo.io/getting-started/quick-start/#prerequisites)
+and install the Hugo binary or package. You can check if it is installed from the command line by running:
 
+```bash
+hugo version
 ```
----
-authors: [OSUOSL Admin]
----
+
+This project uses npm for the functionality of Prettier and Markdownlint. You can check that npm is installed from the
+command line by running:
+
+```bash
+npm -v
 ```
 
-To add a header image at the top of a blog pst, use the CSS tag ``#blog``:
+The search feature is implemented using [Pagefind](https://pagefind.app/) and can be run with the npm script `serve` or
+by [downloading the binary](https://pagefind.app/docs/installation/#downloading-a-precompiled-binary).
+
+### Setup
+
+If you do not have permissions to work directly on a branch of the repository, you will have to
+[fork the repo](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
+and work from your fork. If you do have permission,
+[create a branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)
+and work from your branch.
 
+Once the prerequisites are installed and you are working off the fork or branch,
+[clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
+to your local machine.
+
+This can be done from the command line:
+
+```bash
+# Fork
+git clone git@github.com:YOURUSERNAMEHERE/website.git ./osl-website
+
+# Branch
+git clone git@github.com:osuosl/website.git ./osl-website
 ```
-![Image Alt](/images/image_path#blog)
+
+Then, navigate to the folder and then install the dependencies:
+
+```bash
+cd ./osl-website
+npm install
+```
+
+### Local Development
+
+To compile and host the site under development on port `1313`, run:
+
+```bash
+hugo server
+```
+
+Once Hugo is done setting up, you should see a success message:
+
+```shell
+Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
+Press Ctrl+C to stop
+```
+
+#### Formatting and Linting
+
+This project uses [prettier](https://prettier.io) and [markdownlint](https://github.com/DavidAnson/markdownlint). You
+can install them in your preferred editor to see changes as you edit or run them from the command line.
+
+To format and lint from the command line, run:
+
+```bash
+# Format via prettier
+npm run format
+
+# Lint via markdownlint
+npm run lint
 ```
 
-Dependencies
-------------
+### Preview Production
 
-The search feature is implemented using [Pagefind](https://pagefind.app/) and can be installed with `npx` or by [downloading the binary](https://pagefind.app/docs/installation/#downloading-a-precompiled-binary).
+If you want to preview the production server to see the full search functionality, you can build the pages and then
+serve from Pagefind. Pagefind sources from the `public/` directory Hugo compiles when the website is built.
 
-Development
------------
+First compile the pages:
 
-To compile and host the site under development on port 1313, use:
+```bash
+hugo
+```
+
+Then run it using Pagefind through the provided helper npm script or the binary using the specific flags:
 
+```bash
+# NPM helper script
+npm run serve
+
+# Binary
+./pagefind --site public --serve
 ```
-$ hugo server
+
+## Adding Content
+
+Content is added inside the `/content` folder, though it varies based on what you would like to do.
+
+### Adding a New Blog Post
+
+Regular pages use the default `/archetypes/default.md` archetype.
+
+Blog posts are stored in `/content/blog` and use the associated `/archetypes/blog.md` archetype.
+
+To add a blog post, use the `hugo new` command:
+
+```bash
+hugo new blog/your-slug-title-here.md
 ```
 
-Pagefind sources from the `public/` directory hugo compiles when the website is built. To view the website with full functionality:
+The author of a page should be included as an array of `authors` within the front matter:
 
-First compile it:
+```md
+---
+# ...
+authors: [OSUOSL Admin]
+# ...
+---
 ```
-$ hugo
+
+To add a header image at the top of a blog post, use the CSS tag `#blog`:
+
+```md
+![Image Alt](/images/image_path#blog)
 ```
 
-Then run it using pagefind:
+### Adding a New Tag
+
+Tags (called Terms in Hugo) are added simply by adding an associated string in the frontmatter of a blog post. This
+alone will create a semi-broken tag due to how tags are rendered, so you will have to add an associated page in the
+content folder to add metadata.
+
+After you add a tag to a blog post, create a new file in the directory `/content/tags/[tag name here]/_index.md`, making
+the folder if it does not already exist.
+
+Inside this file, include the frontmatter template below as well as any content you want displayed along with the tag:
+
+```markdown
+---
+title: "Example Tag Here"
+slug: example-tag-here
+---
+
+Content here will be placed on the tag page. You may also include images here.
 ```
-$ ./pagefind --site public --serve
-```
+
+If you do not do this, the tag will be displayed as not having a name.
+
+## License
+
+[Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)

archetypes/blog.md

@@ -0,0 +1,8 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date | dateFormat "2006-04-13" }}
+authors: ["OSL Admin"]
+slug: {{ .Name }}
+tags: []
+draft: true
+---

archetypes/default.md

@@ -1,6 +1,4 @@
 ---
 title: "{{ replace .Name "-" " " | title }}"
-date: {{ .Date }}
-draft: true
+slug: {{ .Name }}
 ---
-