feat(website): work on new website content behind the scenes

.vscode/setings.json

@@ -0,0 +1,15 @@
+{
+  "yaml.schemas": {
+    "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+  },
+  "yaml.customTags": [ 
+      "!ENV scalar",
+      "!ENV sequence",
+      "!relative scalar",
+      "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+      "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+      "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
+      "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
+  ],
+  "git.alwaysSignOff": true
+}

Pipfile

@@ -0,0 +1,23 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+mkdocs-git-revision-date-localized-plugin = "*"
+mkdocs-material = "*"
+mkdocs-minify-plugin = "*"
+mkdocs-redirects = "*"
+pillow = "*"
+cairosvg = "*"
+mkdocs-rss-plugin = "*"
+mkdocs-git-committers-plugin-2 = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.13"
+
+[scripts]
+dev = "mkdocs serve -w ./data --watch-theme -v"
+build = "mkdocs build -d public"

data/theme/main.html

@@ -0,0 +1,13 @@
+{% extends "base.html" %}
+
+{% block announce %}
+  <strong>
+    Welcome to our new site, built with <a href="https://go.recaptime.dev">
+    Material for Mkdocs</a>!
+  </strong>
+  Some pages are still missing, others are being removed or revamped in the new website
+  design.
+  <br>
+  <a href="https://github.com/recaptime-dev/website/issues">Let us know</a> about
+  your experience with the site revamp in the issue tracker.
+{% endblock %}

data/theme/partials/copyright.html

@@ -0,0 +1,31 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+<div class="md-copyright footer-links">
+  {% if config.copyright %}
+    <div class="md-copyright__highlight">
+      {{ config.copyright }}
+    </div>
+  {% endif %}
+  {% if not config.extra.generator == false %}
+    Made with
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+      Material for MkDocs
+    </a>
+  {% endif %}
+  {% if config.extra.hcb and not config.extra.hcb.hide == true %}
+      <p class="footer-text">
+          <a
+          href="https://hcb.hackclub.com/{{ config.extra.hcb.org_slug }}">{{config.extra.hcb.org_name}}</a>
+          is <a href="https://hackclub.com/fiscal-sponsorship">fiscally sponsored</a> by
+          <a href="https://hackfoundation.org">The Hack Foundation</a> (d.b.a <a href="https://hackclub.com">
+          Hack Club</a>), a US 501(c)(3) non-profit with EIN 81-2908499.
+      </p>
+  {% endif %}
+
+  <ul>
+    {% for link in config.extra.footer_links %}
+    <li><a href="{{ link.href }}">{{ link.label }}</a></li>
+    {% endfor %}
+  </ul>
+</div>

mkdocs.yml

@@ -0,0 +1,155 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+# Site metadata
+site_name: Recap Time Squad
+site_author: Recap Time Squad Crew
+copyright: >-
+  Copyright © 2024 Recap Time Squad and contributiors. Website content licensed under
+  <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC-BY-SA-4.0</a>, unless otherwise specified.
+site_url: https://recaptime.dev
+docs_dir: src
+
+# repository settings
+repo_url: https://github.com/recaptime-dev/website
+edit_uri_template: https://github.dev/recaptime-dev/website/blob/labs/mkdocs-material/docs/{path}
+
+nav:
+- index.md
+- Meta:
+  - projects.md
+  - Imprint: imprint.md
+  - Donate:
+    - donate/index.md
+    - FAQs: donate/faq.md
+    - Our sponsors: sponsors.md
+- Blog: https://blog.recaptime.dev
+- Wiki: https://wiki.recaptime.dev
+
+# theme settings
+theme:
+  custom_dir: data/theme
+  name: material
+  features:
+    #- announce.dismiss
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    # - content.tabs.link
+    - content.tooltips
+    # - header.autohide
+    # - navigation.expand
+    - navigation.footer
+    - navigation.indexes
+    # - navigation.instant
+    # - navigation.prune
+    - navigation.sections
+    - navigation.tabs
+    # - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    # - toc.integrate
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      accent: yellow
+      primary: pink
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      accent: yellow
+      primary: pink
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+# markdown extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      normalize_issue_symbols: true
+      repo_url_shorthand: true
+      user: squidfunk
+      repo: mkdocs-material
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      auto_append:
+        - includes/mkdocs.md
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+      combine_header_slug: true
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+extra:
+  hcb:
+    hide: false
+    org_slug: recaptime-dev
+    org_name: Recap Time Squad
+  social:
+    - icon: material/bank-outline
+      link: https://hcb.hackclub.com/recaptime-dev
+      name: See our finances on HCB
+    - icon: simple/opencollective
+      link: https://opencollective.com/recaptime-dev
+      name: See our finances on Open Collective
+    - icon: material/mastodon
+      link: https://mastodon.xyz/@RecapTimeSquad
+      name: Follow the crew on the fediverse
+    - icon: simple/bluesky
+      link: https://bsky.app/profile/recaptime.dev
+      name: Follow the crew on Bluesky
+  footer_links:
+  - label: Privacy Policy
+    href: https://policies.recaptime.dev/privacy
+  - label: Terms of Service
+    href: https://policies.recaptime.dev/terms
+  - label: Imprint / Official docs
+    href: /imprint
+
+extra_css:
+  - assets/stylesheets/theme.css

src/assets/stylesheets/theme.css

@@ -0,0 +1,16 @@
+.md-footer .md-grid {
+    justify-content: stretch;
+}
+.md-footer .md-copyright {
+    margin: 0;
+    flex-grow: 1;
+}
+.footer-links ul {
+    list-style: none;
+    margin: .5em 0 !important;
+    font-size: .64rem;
+}
+.footer-links ul > li {
+    display: inline-block;
+    margin: 0 .25em !important;
+}

src/donate/faq.md

@@ -0,0 +1,104 @@
+# Fundraising, Purchases and Donations FAQs
+
+We complie questions we expect to receive in our inboxes here in this page.
+Still have burning questions? Just shoot us (or the HCB team) an email, addresses
+are mentioned below.
+
+## Is my donation or gift tax-deductible?
+
+If you are from the US (or have tax residency in the US), your donations and gifts
+are tax-deductible to the maximum extent per IRS guidelines. We'll be use them to
+support our projects and team while keeping aligned with Hack Club's (our fiscal
+sponsor) mission.
+
+If you are outside the US, tax-deductibility only applies within the US as our
+fiscal sponsor is based in the US. While we can't answer tax questions before
+you donate, we can still answer other questions via email at `[email protected]`
+or reach out the HCB team at `[email protected]`.
+
+## Is my donation/purchase secure?
+
+Yes, we use [Stripe](https://stripe.com) as our payments processor and we do not
+have access to raw card numbers (they are encrypted behind the scenes and only
+[select Stripe employees can access them](https://stripe.com/docs/security)).
+
+## Do you usually issue a receipt or invoice?
+
+Yes, we usually issue you an email receipt after we processed your donation. If
+you need a PDF version of it, we can issue one via Open Collective or use the
+provided template from our fiscal sponsor.
+
+For donation invoices, we use the HCB platform to issue them but if you prefer
+not to use [Stripe Invoicing](https://stripe.com/invoicing), [we have a form]
+for that (or just email us).
+
+[we have a form]: https://recaptimedev.fillout.com/donation-invoice
+
+## Can we cover your fiscal sponsorship fee?
+
+Much appericated if you add 7% to cover the fees on your donation amount.
+Even better if you also [donate to Hack Club HQ] as Platform Tip (for those
+familiar with using Open Collective to donate to open-source projects and
+communities there).
+
+[donate to Hack Club HQ]: https://hcb.hackclub.com/donations/start/hq
+
+## How do I request a refund? What is your refund policy?
+
+Send us a email at `[email protected]` for donations and other kinds of finanical
+contributions or `[email protected]` for anything else and we'll look onto it. Make
+sure to have your donation/order/transaction ID handy in your request (if it is from
+HCB, just reply to the receipt email; for PayPal, use the merchant transaction ID).
+
+We generally review and process refund requests with 72 hours on the receipt of the request
+for the following reasons ([adopted from the Open Collective docs][oc-refund-policy]):
+
+* Mistaken or accidental donations (including unauthorized transactions if it is not
+you per card issuer policies on disputes)
+* Unmet expectations regarding products/services we provide
+* Double charges
+* Cancelled events and subscriptions (your subscription will be cancelled immediately
+once refunded)
+* Changes in circumstances or financial difficulties
+* Incorrect amount
+
+[oc-refund-policy]: https://docs.opencollective.com/help/about/refund-policy
+
+Please note that we may not be able to refund (either in full or part) if:
+
+* that amount is used or being used towards our projects or for team payroll
+* held in reserves or transferred to one of the following:
+    * Hack Club HQ or any affliated projects or events
+    * an organization fiscally-sponsored by Hack Club through HCB or 501\(c)(3) US non-profit (or similar outside the US)
+
+Currently, we can only process refunds for debit/credit card transactions processed via
+Stripe or PayPal due to the risk of refund fraud. Direct debit transactions processed
+through Stripe are also eligible for refunds, but may take longer to review and process
+for bank account holders outside the US.
+
+## What are statement descriptors you use for bank statements?
+
+We use the following statement descriptors for online donations through the HCB fiscal
+sponsorship platform:
+
+* `HCKCLB` - HCB's short-form statement descriptor for card authorizations
+* `HCB* RECAP TIME SQUAD` - Donations to [Recap Time Squad](https://hcb.hackclub.com/recaptime-dev) on HCB
+* `HCB* LOREBOOKS.WIKI` - Donations to [Community Lorebooks](https://hcb.hackclub.com) on HCB
+
+Outside the HCB where we handle transactions ourselves via Stripe on places like Open
+Collective, Substack, Ghost and Liberapay (or on our own), we use the following statement
+descriptors:
+
+* `RECAPTIME.DEV` or `RTDEV`
+* `LOREBOOKS.WIKI` or `RTDEV* LOREBOOKS.WIKI`
+
+Andrei Jiroh also use Stripe but its linked bank account points to our bank
+details within the HCB platform (instead of pointing to his Wise USD balances
+to also benefit Recap Time Squad and its projects), and uses the following
+statement descriptors:
+
+* `ANDREIJIROH.DEV` - mainly used for [his Ghost blog](https://blog.andreijiroh.dev)
+* `SUBSTACK.ANDREIJIROH.DEV` - for [paid subscriptions on his Substack](https://ajhalili2006.substack.com)
+
+If you donate via our GitHub Sponsors, Ko-fi, or Discord Server Store page, platform
+refund policies apply.