Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 1.9 KB

README.md

File metadata and controls

65 lines (38 loc) · 1.9 KB
Raw

Minimalist Joy UI Blog

Features

✓ Built with TypeScript

✓ Designed with Joy UI's default styles

✓ Ready to publish with Next.js Markdown blog

✓ Light and dark modes with toggle button

✓ Includes Prettier for code formatting

Created with 💙 by MUI.

Getting started

Create a new repository with this template.

Clone the repo, then run:

npm install

To start the app in dev mode, run:

npm run dev

Customizing

Personalizing

  • Your blog's metadata lives in /lib/siteMetaData.ts.
  • Your personal contact info is in /pages/contact.tsx.

Add your details in these two files.

  • Your blog's favicon is located in /public/.
  • Your avatar (for the About page) is in /public/images/.
  • The /public/images/ directory also contains a generic Open Graph card.

Replace these three images with your own.

Publishing

Blog posts are written in Markdown (.md) and kept in the /posts/ folder. The demo blog posts contain common Frontmatter keys (title, date, summary, etc.), but you can add or remove as many as you like—just be sure to update /pages/blog.tsx and /pages/blog/[id].tsx to reflect any changes.

Styling

This blog uses Joy UI, a React component library maintained by MUI (the creators of Material UI).

The template is designed almost entirely with Joy UI's default settings, so the customization is minimal out of the box.

There are three ways you can apply custom styles to this template:

  • inline, directly on a Joy UI component, using the sx prop
  • at the theme level, in /lib/theme.ts
  • globally, on the <GlobalStyles /> component in /pages/_app.tsx

Learn more about customization approaches in Joy UI.