dimatill / the-guild-website

The Guild website & blog

Home Page:https://the-guild.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

the-guild.dev

Installing Dependencies

Run yarn from the root directory to get all the dependencies installed

Running the website (Development mode)

Run yarn dev to start the server locally with live reload setup

Note: Kindly ignore the warning regarding lqip when loading svg images. It is being tracked here

Build and run the website (Production)

Run yarn build followed by yarn start to run the website in production mode

Contributing to our blog

We use MDX (Markdown with JSX) for our blog posts. To add a new blog post,

  • Create a new mdx file in pages/blog directory with the same template as other blog posts
  • Update the meta object with all the information regarding the blog post including title, thumbnails, author name, etc.
  • Any assets related to the blog can be placed in public/blog-assets directory within its own folder
  • If you are contributing for the first time, make sure that you add your details in ui/blog/authors.tsx file with a new entry to the authors object.
  • Once you send us a PR, we will review the same, provide the feedback as necessary and merge it if everything looks good.

About

The Guild website & blog

https://the-guild.dev


Languages

Language:TypeScript 71.7%Language:JavaScript 28.2%Language:Shell 0.0%