https://github.com/headwindz/nextjs-windi-typescript-starter-blog
A starter blogging template powered by nextjs, windicss and typescript
https://github.com/headwindz/nextjs-windi-typescript-starter-blog
blogging contentlayer nextjs react template typescript windicss
Last synced: 10 months ago
JSON representation
A starter blogging template powered by nextjs, windicss and typescript
- Host: GitHub
- URL: https://github.com/headwindz/nextjs-windi-typescript-starter-blog
- Owner: headwindz
- License: mit
- Created: 2022-01-30T15:49:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-04T12:58:13.000Z (over 3 years ago)
- Last Synced: 2024-03-07T16:49:20.109Z (about 2 years ago)
- Topics: blogging, contentlayer, nextjs, react, template, typescript, windicss
- Language: TypeScript
- Homepage: https://nextjs-windi-typescript-starter-blog-n0rush.vercel.app/
- Size: 353 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> This project is still WIP
Nextjs Windi Typescript Starter Blog
A starter blogging template powered by [nextjs], [windicss] and [typescript]
[![license-img]][license-link] [![version-img]][version-link]
[nextjs]: https://nextjs.org
[windicss]: https://windicss.org
[typescript]: https://www.typescriptlang.org/
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg
[license-link]: https://github.com/n0ruSh/nextjs-windi-typescript-starter-blog/blob/main/LICENSE
[version-img]: https://img.shields.io/github/package-json/v/n0ruSh/nextjs-windi-typescript-starter-blog
[version-link]: https://github.com/n0ruSh/nextjs-windi-typescript-starter-blog/blob/main/package.json#L3
# 💖 Used by
- [Demo](https://nextjs-windi-typescript-starter-blog-n0rush.vercel.app/) - this repo
Are you using the template🚗 ? Please add yourself to the list above via a PR
## 🎉 Features
- Written in Typescript, with native type support.
- i18n
- Responsive design - mobile friendly
- Light and dark mode support
- Current best web engineering practices: lint + prettier + husky + commintlint + lint-staged
- Support for tags
- [] Powerful search with Algolia
- [] PR workflow - Run checks/lints on PR and preview
## 🔨 Usage
1. Clone the repo
1. Customize `theme.config.ts`
1. Customize `data/intro/index.md` and `data/intro/index.zh-CN.md` (about author)
1. Update blogs `data/blogs/*` with your own blogs
1. Update `components/footer/index.tsx` to customize social information
1. Deploy on Vercel
## 📦 Installation
```bash
$ yarn
```
## 🚗 Development
First, run the development server:
```bash
yarn run dev
```
Open your browser and visit [http://localhost:3000](http://localhost:3000).
## 📕 Overview
- `theme.config.js` - Theme configuration
- `next.config.js` - Nextjs configuration
- `windi.config.ts` - Windicss configuration
- `pages/*` - Static pages
- `data/*` - MDX data that is used for introduction and blogs
- `public/*` - Static assets
- `interface/index.ts` - Common types
- `styles/index.css` - Common custom variant
- `styles/prism.css` - Prism theme for code blocks
## 🙏 Credit
Inspired by the following awesome work:
[leerob.io](https://github.com/leerob/leerob.io)
[antfu.me](https://github.com/antfu/antfu.me)
[tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog)
## 🎈 License
This project is [MIT licensed](./LICENSE).