Giter VIP home page Giter VIP logo

next-js-blog-boilerplate's Introduction

Next js Blog Boilerplate

Nextjs starter banner

๐Ÿš€ Next.js Blog Boilerplate is starter code for your blog based on Next.js framework. โšก๏ธ Made with Next.js, TypeScript, ESLint, Prettier, PostCSS, Tailwind CSS.

Clone this project and use it to create your own Next.js blog. You can check a Next js blog templates demo.

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

Premium Themes (Nextjs Themes)

Blue Dark Nextjs Theme Blue Eclatant Nextjs Theme
Blue Dark Nextjs Theme premium Blue Eclatant Nextjs Theme premium
Blue Modern Nextjs Theme Blue Minimalist Nextjs Theme
Blue Modern Nextjs Theme premium Blue Minimalist Nextjs Theme premium

Getting started

Run the following command on your local environment:

git clone --depth=1 https://github.com/ixartz/Next-js-Blog-Boilerplate.git my-project-name
cd my-project-name
npm install

Then, you can run locally in development mode with live reload:

npm run dev

Open http://localhost:8080 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

Contributions

Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.

License

Licensed under the MIT License, Copyright ยฉ 2020

See LICENSE for more information.


Made with โ™ฅ by CreativeDesignsGuru

next-js-blog-boilerplate's People

Contributors

arnorhaux avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.