From ff4a58350c7424105e1e35561ec56a4890798fa1 Mon Sep 17 00:00:00 2001 From: Lachlan Campbell Date: Fri, 24 Apr 2020 09:47:40 -0400 Subject: [PATCH] Add README --- README.md | 122 ++------------------------------------------------- package.json | 2 +- 2 files changed, 4 insertions(+), 120 deletions(-) diff --git a/README.md b/README.md index d46fc299..107e18a2 100755 --- a/README.md +++ b/README.md @@ -1,126 +1,10 @@ -# Hack Club Theme Starter +# Hack Club v3 -A sample [Next.js] project for getting started with [MDX], [Theme UI], & [Hack Club Theme]. +Our new, new website—powered by [Next.js] with [MDX], [Theme UI], & [Hack Club Theme]. [next.js]: https://nextjs.org [mdx]: https://mdxjs.com [theme ui]: https://theme-ui.com [hack club theme]: https://github.com/hackclub/theme -## Usage - -1. Import this repo to your coding environment of choice. Download it, `git clone`, or use the GitHub import on Glitch/Repl.it. -2. `yarn` to install dependencies. -3. `yarn dev` to start your server. -4. Start adding your own pages & components in their respective directories. - -## Configuration - -### Theme switcher - -We’ve included an example theme switcher component at `components/color-switcher.js`, -which is included on every page through its inclusion in `pages/_app.js`. -Feel free to change it. - -### Hack Club fonts - -If you’re making a Hack Club HQ project, you’re allowed to use Hack Club’s font, -[Phantom Sans](https://www.futurefonts.xyz/phantom-foundry/phantom-sans). -To load it, simply uncomment the `import '@hackclub/theme/fonts/reg-bold.css'` -line in `_app.js`. - -### Custom theme - -By default, the raw [Hack Club Theme](https://theme.hackclub.com) will be used. -If you’d like to edit the theme, we recommend making a theme file (perhaps at -`lib/theme.js`) along these lines: - -```js -import base from '@hackclub/theme' - -const theme = base - -// theme.fontSizes = […] -// theme.fonts.heading = '' - -export default theme -``` - -### Running at another port - -Super easy: `yarn dev -p 5000` - -### Adding meta tags - -These template includes [@hackclub/meta](https://github.com/hackclub/theme/tree/master/packages/meta) -for adding meta tags to Hack Club HQ sites. To set default meta tags across all pages, -add the following to `pages/_app.js`: - -```js -// import Head from 'next/head' - - - - -``` - -If you’re not making a site for HQ, don’t use `@hackclub/meta`, since it adds -Hack Club’s favicons & info. Instead, we recommend making your own component, -perhaps at `components/meta.js`. - -
- -Example code - -```js -import Head from 'next/head' -import theme from '@hackclub/theme' // or '../lib/theme' - -export default ({ - name = 'Your Company', - title = 'Your Project', - description = '', - image = 'https://yourproject.now.sh/card.png', - url = 'https://yourproject.now.sh/' -}) => ( - - {title} - - - - - - - - - - - - - - -) -``` - -
- -## Deployment - -[![Deploy with ZEIT Now](https://zeit.co/button)](https://zeit.co/import/project?template=https://github.com/hackclub/theme-starter) - -We recommend using [ZEIT Now](https://zeit.co) for deployment. It requires no -configuration, is totally free for personal projects, and supports all the features -of Next.js with the best performance. Refer to [their documentation](https://zeit.co/docs#deploy-an-existing-project) -for more details. - -If you’re only making a static site (e.g. no [`getServerSideProps`](https://nextjs.org/docs/basic-features/data-fetching#getserversideprops-server-side-rendering) -or [API Routes](https://nextjs.org/docs/api-routes/introduction)), you can also -deploy on [Netlify](https://netlify.com), which is also free. Refer to [their documentation](https://docs.netlify.com/configure-builds/common-configurations/#next-js) -on the necessary configuration. +Code under MIT License, assets may not be re-used or re-distributed. diff --git a/package.json b/package.json index 810ae25b..7974321c 100755 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@hackclub/theme-starter", + "name": "@hackclub/v3", "version": "0.0.1", "author": "Lachlan Campbell ", "license": "MIT",