tailwind-nextjs-starter-blog README

The project's README from github.com/timlrx/tailwind-nextjs-starter-blog. As one markdown file: README.md.

tailwind-nextjs-banner

Tailwind Nextjs Starter Blog

GitHub Repo stars GitHub forks Twitter URL Sponsor

Deploy with Vercel

This is a Next.js, Tailwind CSS blogging starter template. Version 2 is based on Next App directory with React Server Component and uses Contentlayer to manage markdown content.

Probably the most feature-rich Next.js markdown blogging template out there. 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!

Variations

Note: These are community contributed forks using different frameworks or with significant changes to the codebase - not officially supported.

Astro alternative - Tailwind Astro Template.

Remix-run alternative - Tailwind Remix-run Starter Blog Template.

Internationalization support - Template with i18n and source code.

Examples V2

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

Examples V1

v1-blogs-showcase.webm

Thanks to the community of users and contributors to the template! We are no longer accepting new blog listings over here. If you have updated from version 1 to version 2, feel free to remove your blog from this list and add it to the one above.

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

Sample posts

Quick Start Guide

  1. Clone the repo
npx degit 'timlrx/tailwind-nextjs-starter-blog'
  1. Personalize siteMetadata.js (site related information)
  2. Modify the content security policy in next.config.js if you want to use other analytics provider or a commenting solution other than giscus.
  3. Personalize authors/default.md (main author)
  4. Modify projectsData.ts
  5. Modify headerNavLinks.ts to customize navigation links
  6. Add blog posts
  7. Deploy on Vercel

Installation

yarn

Please note, that if you are using Windows, you may need to run:

$env:PWD = $(Get-Location).Path

Development

First, run the development server:

yarn dev

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

Edit the layout in app or content in data. With live reloading, the pages auto-updates as y

tailwind-nextjs-starter-blog (timlrx/tailwind-nextjs-starter-blog)

Searching Database…

Что это такое?Это стартовый шаблон для блога на Next.js и Tailwind CSS, заранее настроенный для технических текстов и позиционируемый как замена существующих личных блогов на Jekyll или Hugo.
Это хостинговый сервис для блогов или что-то, что я запускаю сам?Это шаблон кода, а не сервис: вы клонируете репозиторий, правите конфиг и markdown-файлы, а затем сами разворачиваете получившийся сайт — быстрый старт завершается деплоем на Vercel.
Как мне пройти путь от клонирования репозитория до работающего блога?Склонируйте репозиторий, настройте под себя siteMetadata.js и authors/default.md, подправьте projectsData.ts и headerNavLinks.ts, добавьте свои посты и разверните сайт на Vercel; локально dev-сервер запускается через next dev.
Есть ли подводные камни, о которых стоит знать заранее?Пара мелочей: на Windows во время установки может понадобиться выполнить дополнительную команду, а если вы используете сервис аналитики или комментариев не по умолчанию (не giscus), придётся обновить политику безопасности контента в next.config.js.
Почему автор сделал это, вместо того чтобы пользоваться Jekyll или Hugo?Он хотел перенести свой существующий блог на Next.js и Tailwind CSS и не нашёл простого готового шаблона, поэтому создал свой — стремясь к богатству возможностей шаблонов вроде beautiful-jekyll и Hugo Academic, но с экосистемой React и современными практиками веб-разработки.
Есть ли версия для Astro или Remix?Да, обе существуют в виде форков от сообщества — шаблон для Astro с Tailwind и стартовый блог на Remix-run с Tailwind, — плюс вариант с поддержкой нескольких языков, но в README эти вариации явно помечены как официально не поддерживаемые.
Кто реально этим пользуется?Длинная витрина работающих сайтов: личные блоги разработчиков, портфолио, сайт подкаста и продуктовые блоги, включая блог самого автора. Если ваш блог использует этот шаблон, README приглашает добавить его в список примеров V2 через PR.
Creator
timlrx
Size
9.6 MB
Stars
10.6K
Age
5y
Commits · 90 Days