Overview:
The Hack Club Theme Starter is a sample Next.js project designed to help users get started with MDX, Theme UI, and the Hack Club Theme. It provides a structured template for creating websites and includes features such as a theme switcher, customizable fonts, meta tags, and analytics integration. The project can be easily deployed with Vercel or Netlify.
Features:
- MDX, Theme UI, & Hack Club Theme: This project utilizes MDX, Theme UI, and the Hack Club Theme to create a cohesive and customizable website.
- Theme Switcher: The project includes an example theme switcher component that can be customized or replaced to change the website’s theme.
- Customizable Fonts: Users can make use of the Hack Club’s font, Phantom Sans, by uncommenting a line of code. This is particularly useful for Hack Club HQ projects.
- Custom Theme: The project allows users to edit the theme by creating a theme file, giving them full control over the website’s visual style.
- Running at Another Port: Users can easily run the project on a different port by adding a command line argument.
- Adding Meta Tags: The project includes an integration with @hackclub/meta, allowing users to add meta tags to their Hack Club HQ sites.
- Adding Analytics: Users can easily integrate Fathom Analytics into their project for privacy-focused analytics. The necessary scripts and configurations are provided.
Installation:
- Import this repo to your coding environment of choice. Download it, git clone, or use the GitHub import on Glitch/Repl.it.
- Run
yarn
to install dependencies. - Run
yarn dev
to start the server. - Start adding your own pages and components in their respective directories.
Summary:
The Hack Club Theme Starter is a useful starting point for creating websites with Next.js, MDX, Theme UI, and the Hack Club Theme. It provides various features such as a theme switcher, customizable fonts, meta tags, and analytics integration. The project can be easily installed and deployed with Vercel or Netlify. Whether you’re creating a Hack Club HQ project or any other website, this starter project can save you time and provide a solid foundation for your development.