tailwind-nextjs-blog/README.md

Tailwind Nextjs Starter Blog

This is a Next.js, Tailwind CSS blogging starter template. Probably the most feature-rich Next.js markdown blogging template out there. Comes out of the box configured with the latest technologies to make technical writing a breeze. Easily configurable and customizable. Perfect as a replacement to existing Jekyll and Hugo individual blogs.

Check out the documentation below to get started.

Facing issues? Check the FAQ page and do a search on past issues. Feel free to open a new issue if none has been posted previously.

Feature request? Check the past discussions to see if it has been brought up previously. Otherwise, feel free to start a new discussion thread. All ideas are welcomed!

Examples

• Demo Blog - this repo
• My personal blog - modified to auto-generate blog posts with dates
• Aloisdg's cookbook - with pictures and recipes!
• GautierArcin's demo with next translate - includes translation of mdx posts, source code
• David Levai's digital garden - customized design and added email subscriptions
• Thinh's Corner - customized layout with sticky side table of contents
• Leo's Blog - Tuan Anh Huynh's personal site. Add Snippets Page, Author Profile Card, Image Lightbox, ...
• thvu.dev - Added mdx-embed, view count, reading minutes and more.
• fiqrychoerudin.dev - simple portfolio.
• irvin.dev - Irvin Lin's personal site. Added YouTube embedding.
• the all JavaScript Blog - a JavaScript enlightenment blog uses this
• KirillSo.com - Personal blog & website.
• DevBoy Blog - M.Reza's personal blog
• slightlysharpe.com - Tincre's main company blog
• blog.b00st.com - b00st.com's main music promotion blog
• astrosaurus.me - Ephraim Atta-Duncan's Personal Blog
• dhanrajsp.me - Dhanraj's personal site and blog.
• blog.r00ks.io - Austin Rooks's personal blog (source code).
• alfoncode.com - Alfonso García's personar website. Customized design (source code)

Using the template? Feel free to create a PR and add your blog to this list.

Motivation

I wanted to port my existing blog to Nextjs and Tailwind CSS but there was no easy out of the box template to use so I decided to create one. Design is adapted from Tailwindlabs blog.

I wanted it to be nearly as feature-rich as popular blogging templates like beautiful-jekyll and Hugo Academic but with the best of React's ecosystem and current web development's best practices.

Features

• 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
• Light and dark theme
• Self-hosted font with Fontsource
• Supports plausible, simple analytics and google analytics
• MDX - write JSX in markdown documents!
• Server-side syntax highlighting with line numbers and line highlighting via rehype-prism-plus
• Math display supported via KaTeX
• Citation and bibliography support via rehype-citation
• Automatic image optimization via next/image
• Flexible data retrieval with mdx-bundler
• Support for tags - each unique tag will be its own page
• Support for multiple authors
• Blog templates
• TOC component
• Support for nested routing of blog posts
• Newsletter component with support for mailchimp, buttondown, convertkit and klaviyo
• Supports giscus, utterances or disqus
• Projects page
• Preconfigured security headers
• SEO friendly with RSS feed, sitemaps and more!

Sample posts

• A markdown guide
• Learn more about images in Next.js
• A tour of math typesetting
• Simple MDX image grid
• Example of long prose
• Example of Nested Route Post

Quick Start Guide

1. JS (official support)

npx degit https://github.com/timlrx/tailwind-nextjs-starter-blog.git

or with TypeScript (community support)

npx degit timlrx/tailwind-nextjs-starter-blog#typescript

2. Personalize siteMetadata.js (site related information)
3. Modify the content security policy in next.config.js if you want to use any analytics provider or a commenting solution other than giscus.
4. Personalize authors/default.md (main author)
5. Modify projectsData.js
6. Modify headerNavLinks.js to customize navigation links
7. Add blog posts
8. Deploy on Vercel

Installation

npm install

Development

First, run the development server:

npm start

or

npm run dev

Open 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.

Extend / Customize

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.

Post

Frontmatter

Frontmatter follows Hugo's standards.

Currently 10 fields are supported.

title (required)
date (required)
tags (required, can be empty array)
lastmod (optional)
draft (optional)
summary (optional)
images (optional, if none provided defaults to socialBanner in siteMetadata config)
authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified)
layout (optional list which should correspond to the file names in `data/layouts`)
canonicalUrl (optional, canonical url for the post for SEO)

Here's an example of a post's frontmatter:

---
title: 'Introducing Tailwind Nexjs Starter Blog'
date: '2021-01-12'
lastmod: '2021-01-18'
tags: ['next-js', 'tailwind', 'guide']
draft: false
summary: 'Looking for a performant, out of the box template, with all the best in web technology to support your blogging needs? Checkout the Tailwind Nextjs Starter Blog template.'
images: ['/static/images/canada/mountains.jpg', '/static/images/canada/toronto.jpg']
authors: ['default', 'sparrowhawk']
layout: PostLayout
canonicalUrl: https://tailwind-nextjs-starter-blog.vercel.app/blog/introducing-tailwind-nextjs-starter-blog
---

Compose

Run node ./scripts/compose.js to bootstrap a new post.

Follow the interactive prompt to generate a post with pre-filled front matter.

Deploy

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.

Support

Using the template? Support this effort by giving a star on GitHub, sharing your own blog and giving a shoutout on Twitter or becoming a project sponsor.

Licence

MIT © Timothy Lin