Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.72 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.72 KB
Raw

Hack Club Theme for Mkdocs

Note: This project is not affiliated with Hack Club HQ, and maintained as a community project.

A Mkdocs theme for Hack Clubbers and projects related to Hack Club. Currently in early development public preview, built during High Seas.

Demo: https://hackclub-theme.mkdocs.lorebooks.wiki

Usage

  1. Install via your favorite package manager:
# pipenv
pipenv install mkdocs-hackclub

# poetry
poetry add mkdodcs-hackclub
  1. Point your theme.name to hackclub in your Mkdocs config.
theme:
    name: hackclub

Support the development

ℹ️ Fiscal sponsorship disclosure: Recap Time Squad is fiscally sponsored by The Hack Foundation (d.b.a. Hack Club), a 501(c)(3) US nonprofit (EIN: 81-2908499).

You can support the development of this theme financially by donating to Recap Time Squad or directly sponsoring Andrei Jiroh's open source work (25% of sponsorship revenue and donations to Andrei Jiroh will be dedicated to Recap Time Squad projects like this one).

Alternatively, you can also lend a hand in developing and maintaining the project. Learn more in the contributing guidelines

License

  • Code: MIT, following upstream project's license
  • Documentation at ./docs directory: CC-BY-SA-4.0