73nko / alex-web

New website built in NextJs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Next js Blog Boilerplate with Tailwind CSS

πŸš€ Next.js Blog Boilerplate is starter code for your blog based on Next.js 10+ framework with Tailwind CSS 2.0. ⚑️ Made with Next.js, TypeScript, ESLint, Prettier, PostCSS, Tailwind CSS.

Features

Blog feature:

  • 🎈 Syntax Highlighting with Prism.js
  • πŸ€– SEO metadata and Open Graph tags
  • βš™οΈ JSON-LD for richer indexing
  • πŸ“– Pagination
  • 🌈 Include a FREE minimalist blog theme
  • ⬇️ Markdown
  • πŸ’― Maximize lighthouse score

Developer experience first:

Built-in feature from Next.js:

  • β˜• Minify HTML & CSS
  • πŸ’¨ Live reload
  • βœ… Cache busting

Philosophy

  • Minimal code
  • SEO-friendly
  • πŸš€ Production-ready

Requirements

  • Node.js and npm

Getting started

Run the following command on your local environment:

You can run locally in development mode with live reload:

npm run dev

Open http://localhost:3000 with your favorite browser to see your project.

.
β”œβ”€β”€ _posts            # Your blog posts
β”œβ”€β”€ public            # Static files
β”‚   β”œβ”€β”€ assets
β”‚   β”‚   └── images
β”‚   β”‚       └── posts # Images used in your blog posts
└── src
    β”œβ”€β”€ pages         # Next.js pages
    β”œβ”€β”€ styles        # Your blog CSS files
    └── templates     # Blog templates

Customization

You can easily configure Next js Boilerplate. Please change the following file:

  • public/apple-touch-icon.png, public/favicon.ico, public/favicon-16x16.png and public/favicon-32x32.png: your blog favicon, you can generate from https://favicon.io/favicon-converter/
  • public/assets/images/logo.png, public/assets/images/logo-32x32.png: your blog logo
  • src/styles/main.css: your blog CSS file using Tailwind CSS
  • src/utils/Config.ts: configuration file like blog name, url, etc.
  • src/templates/Main.tsx: blog theme

Deploy to production

You can see the results locally in production mode with:

$ npm run build
$ npm run start

The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.

You can create an optimized production build with:

npm run build-prod

Now, your blog is ready to be deployed. All generated files are located at dist folder, which you can deploy with any hosting service.

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify:

Netlify Deploy button

License

Licensed under the MIT License, Copyright Β© 2020

See LICENSE for more information.

About

New website built in NextJs

License:MIT License


Languages

Language:TypeScript 70.1%Language:CSS 28.8%Language:JavaScript 1.1%