https://github.com/kinfe123/testing-rvtcs
https://github.com/kinfe123/testing-rvtcs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/kinfe123/testing-rvtcs
- Owner: Kinfe123
- License: mit
- Created: 2023-05-05T11:15:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-05T11:15:40.000Z (about 3 years ago)
- Last Synced: 2025-02-13T23:28:16.067Z (over 1 year ago)
- Language: TypeScript
- Size: 543 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://og-playground.vercel.app/) 🔥
## 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](https://nextjs.org/docs/api-reference/create-next-app)
```bash
# 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 |
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [](https://vercel.com/new/git/external?repository-url=https://github.com/mverissimo/next-galaxy-starter) | [](https://app.netlify.com/start/deploy?repository=https://github.com/mverissimo/next-galaxy-starter) |
## Built with
- [Nextjs](https://nextjs.org/)
- [Markdoc](https://markdoc.io/)
- [Headless UI](https://headlessui.com/)
- [Tailwindcss](https://tailwindcss.com/)