/next-galaxy-template

Primary LanguageTypeScriptMIT LicenseMIT

Non-opinionated TypeScript template starter for Next.js
All you need to start documenting your project..

Why?

Sometimes creating a documentation website is an exhausting task or spent much time, this template offers all nextjs features and some non-opinionated decisions to improve the developer experience.

Tooling

  • editor config
  • prettier
  • husky
  • commitlint
  • git actions
  • path mapping

Features

  • Callout
  • Disclosure
  • Tabs
  • Code Highlighting

Performance & Design

  • SEO-friendly
  • Mobile-friendly
  • Variable fonts
  • Dark mode
  • New experimental OG IMAGE 🔥

Commands

command description
start starts a simple server with the build production code
dev runs your application on localhost:3000
build creates the production build version
lint runs the linter in all components and pages
test runs jest to test all components and pages

Quick Start

The best way to start with this template is using Create Next App

# yarn
yarn create next-app -e https://github.com/mverissimo/next-galaxy-starter

#npm
npx create next-app -e https://github.com/mverissimo/next-galaxy-starter

Deploy

Deploy this template in one click:

Vercel Netlify
Deploy Netlify

Built with