Repository files navigation

This is aNext.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 theFAQ 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!

• 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 - Addedmdx-embed, view count, reading minutes and more.
• fiqrychoerudin.dev - simple portfolio.

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

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 fromTailwindlabs blog.

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

• Easy styling customization withTailwind 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
• Supportsplausible,simple analytics and google analytics
• MDX - write JSX in markdown documents!
• Server-side syntax highlighting with line numbers and line highlighting viarehype-prism-plus
• Math display supported viaKaTeX
• Citation and bibliography support viarehype-citation
• Automatic image optimization vianext/image
• Flexible data retrieval withmdx-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
• Supportsgiscus,utterances or disqus
• Projects page
• Preconfigured security headers
• SEO friendly with RSS feed, sitemaps and more!

• 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

1. JS (official support)

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

or TS (community support)

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

2. PersonalizesiteMetadata.js (site related information)
3. Personalizeauthors/default.md (main author)
4. ModifyprojectsData.js
5. ModifyheaderNavLinks.js to customize navigation links
6. Add blog posts
7. Deploy on Vercel

npm install

First, run the development server:

npm start

or

npm run dev

Openhttp://localhost:3000 with your browser to see the result.

You can start editing the page by modifyingpages/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 indata/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 andcss/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 fromSimple Icons and map them inindex.js. Other icons useheroicons.

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

Frontmatter followsHugo's standards.

Currently 7 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`)

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: falsesummary: '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---

Runnode ./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 theVercel Platform from the creators of Next.js. Check out theNext.js deployment documentation for more details.

Netlify / GitHub Pages / Firebase etc.
As the template usesnext/image for image optimization, additional configurations have to be made to deploy on other popular static hosting websites likeNetlify orGitHub Pages. An alternative image optimization provider such as Imgix, Cloudinary or Akamai has to be used. Alternatively, replace thenext/image component with a standard<img> tag. Seenext/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.

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

MIT ©Timothy Lin