This repository is the home to my personal website. This website is intended for personal use, and functions as a method of storing/organizing notes and projects.
The site is forked from the incredible Tailwind-Nextjs-Starter-Blog by Tim Lrx.
Check out the starter documentation or fork this project and start building your own blog!
I was originally using a large repository to store my notes, however, I found that I was not able to find the notes I was looking for. There were just too many notes to keep track of, and I was not able to notes quickly. I stumbled upon the Tailwind-Nextjs-Starter-Blog but was hesitant because as a beginner I was not sure how to use Next.js or Tailwind CSS.
Tim Lrx provided a great starting point with awesome documentation. This gave me the foundations to explore and build on top of the starter blog.
- Easy styling customization with Tailwind 3.0 and primary color attribute
- Near perfect lighthouse score - Lighthouse report
- Lightweight, 45kB first load JS, uses Preact in production build
- Mobile-friendly view
- Supports Google Analytics
- MDX - write JSX in markdown documents!
- Server-side syntax highlighting with line numbers and line highlighting via rehype-prism-plus
- Automatic image optimization via next/image
- Flexible data retrieval with mdx-bundler
- Support for tags - each unique tag will be its own page
- Table of content component
- Support for nested routing of blog posts
- Preconfigured security headers
- SEO friendly with RSS feed, sitemaps and more!
npm installFirst, run the development server:
npm startor
npm run devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.
data/siteMetadata.js - contains most of the site related information which should be modified for a user's need.
data/authors/default.md - default author information (required). Additional authors can be added as files in data/authors.
data/projectsData.js - data used to generate styled card on the projects page.
data/headerNavLinks.js - navigation links.
data/logo.svg - replace with your own logo.
data/blog - replace with your own blog posts.
public/static - store assets such as images and favicons.
tailwind.config.js and css/tailwind.css - contain the tailwind stylesheet which can be modified to change the overall look and feel of the site.
css/prism.css - controls the styles associated with the code blocks. Feel free to customize it and use your preferred prismjs theme e.g. prism themes.
components/social-icons - to add other icons, simply copy an svg file from Simple Icons and map them in index.js. Other icons use heroicons.
components/MDXComponents.js - pass your own JSX code or React component by specifying it over here. You can then call them directly in the .mdx or .md file. By default, a custom link and image component is passed.
layouts - main templates used in pages.
pages - pages to route to. Read the Next.js documentation for more information.
next.config.js - configuration related to Next.js. You need to adapt the Content Security Policy if you want to load scripts, images etc. from other domains.
Run node ./scripts/compose.js to bootstrap a new post.
Follow the interactive prompt to generate a post with pre-filled front matter.
Vercel
The easiest way to deploy the template is to use the Vercel Platform from the creators of Next.js. Check out the Next.js deployment documentation for more details.
Netlify / GitHub Pages / Firebase etc.
As the template uses next/image for image optimization, additional configurations have to be made to deploy on other popular static hosting websites like Netlify or GitHub Pages. An alternative image optimization provider such as Imgix, Cloudinary or Akamai has to be used. Alternatively, replace the next/image component with a standard <img> tag. See next/image documentation for more details.
The API routes used in the newsletter component cannot be used in a static site export. You will need to use a form API endpoint provider and substitute the route in the newsletter component accordingly. Other hosting platforms such as Netlify also offer alternative solutions - please refer to their docs for more information.