Skip to content

Commit db153ae

Browse files
authored
feat: make it a theme (atinux#25)
1 parent 7abc54a commit db153ae

31 files changed

+1299
-610
lines changed

.gitignore

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,12 @@ node_modules
55
.cache
66
.output
77
.env
8-
dist
8+
dist
9+
.DS_Store
10+
11+
# Yarn
12+
.yarn/cache
13+
.yarn/*state*
14+
15+
# Local History
16+
.history

README.md

Lines changed: 9 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
[![Content Wind](https://github.com/Atinux/content-wind/raw/main/public/cover.jpg)](https://content-wind.nuxt.dev)
1+
[![Content Wind](https://github.com/Atinux/content-wind/raw/main/public/cover.jpg)](https://content-wind.nuxt.space)
22

33
# Content Wind
44

55
A lightweight Nuxt template to write a Markdown driven website, based on [Nuxt Content](https://content.nuxtjs.org), [TailwindCSS](https://tailwindcss.com) and [Iconify](https://iconify.design).
66

7-
- [Demo & Docs](https://content-wind.nuxt.dev)
7+
- [Demo & Docs](https://content-wind.nuxt.space)
88
- [Play online](https://stackblitz.com/github/Atinux/content-wind?file=content%2F1.index.md)
99

1010
## Features
1111

12-
- [Document-Driven Mode](https://content.nuxtjs.org/guide/writing/document-driven)
13-
- Create pages in Markdown in the `content/` directory
14-
- Use Nuxt layouts in your Markdown pages
15-
- Enjoy meta tag generation from Markdown files
16-
- Generated navigation based on your pages
12+
- Create pages in Markdown in the `content/` directory
13+
- Use Nuxt layouts in your Markdown pages
14+
- Enjoy meta tag generation from Markdown files
15+
- Generated navigation based on your pages
1716
- Switch between Light & Dark mode :moon:
1817
- Access 100,000 icons from 100+ icon sets with the [`<Icon>` component](https://github.com/Atinux/nuxt-icon)
1918
- Highlight code blocks with [Shiki](https://shiki.matsu.io)
@@ -22,55 +21,10 @@ A lightweight Nuxt template to write a Markdown driven website, based on [Nuxt C
2221

2322
## Usage
2423

25-
Take a look at [content-wind.nuxt.dev](https://content-wind.nuxt.dev) for the complete documentation.
26-
27-
## Setup
28-
29-
Make sure to install the dependencies:
30-
31-
```bash
32-
# yarn
33-
yarn install
34-
35-
# npm
36-
npm install
37-
```
38-
39-
## Development Server
40-
41-
Start the development server on http://localhost:3000
42-
43-
```bash
44-
npm run dev
45-
```
46-
47-
## Deployment
48-
49-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FAtinux%2Fcontent-wind) [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Atinux/content-wind)
50-
51-
52-
### Static Hosting
53-
54-
Pre-render the website to be deployed on any static hosting:
55-
56-
```bash
57-
npm run generate
58-
```
59-
60-
The `dist/` directory is ready to be deployed (symlink to `.output/public`), [learn more on Nuxt docs](https://v3.nuxtjs.org/guide/deploy/static-hosting).
61-
62-
### Node server
63-
64-
Build the application for production:
65-
66-
```bash
67-
npm run build
68-
```
69-
70-
Start the server in production:
24+
Start your project with:
7125

7226
```bash
73-
node .output/server/index.mjs
27+
npx nuxi@latest init -t themes/content-wind my-website
7428
```
7529

76-
Learn more on [Nuxt docs](https://v3.nuxtjs.org/guide/deploy/node-server) for more information.
30+
Then follow the instructions and you are ready to go :rocket:

package.json

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,23 @@
11
{
2-
"name": "content-wind",
3-
"private": false,
4-
"version": "0.0.5",
5-
"main": "nuxt.config.ts",
2+
"private": true,
3+
"workspaces": [
4+
"./theme",
5+
"./template"
6+
],
67
"scripts": {
7-
"dev": "nuxi dev",
8-
"build": "nuxi build",
9-
"generate": "nuxi generate",
10-
"preview": "nuxi preview",
11-
"lint": "eslint ."
12-
},
13-
"dependencies": {
14-
"@nuxt/content": "^2.1.1",
15-
"@nuxtjs/color-mode": "^3.1.7",
16-
"@nuxtjs/tailwindcss": "^5.3.3",
17-
"@tailwindcss/typography": "^0.5.7",
18-
"nuxt-icon": "^0.1.6"
8+
"dev": "nuxi dev template",
9+
"build": "nuxi build template",
10+
"generate": "nuxi generate template",
11+
"preview": "nuxi preview template",
12+
"lint": "eslint .",
13+
"release": "cd theme && standard-version && git push --follow-tags && npx npm publish",
14+
"postinstall": "nuxi prepare theme"
1915
},
2016
"devDependencies": {
2117
"@nuxtjs/eslint-config-typescript": "^11.0.0",
2218
"eslint": "^8.24.0",
2319
"nuxt": "^3.0.0-rc.11",
20+
"standard-version": "^9.5.0",
2421
"typescript": "^4.8.4"
2522
}
2623
}

template/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# My Website
2+
3+
Beautiful website propulsed by [content-wind](https://github.com/Atinux/content-wind) theme.
4+
5+
## Setup
6+
7+
Make sure to install the dependencies:
8+
9+
```bash
10+
# yarn
11+
yarn install
12+
13+
# npm
14+
npm install
15+
```
16+
17+
## Development Server
18+
19+
Start the development server on http://localhost:3000
20+
21+
```bash
22+
npm run dev
23+
```
24+
25+
## Deployment
26+
27+
Head over the [Nuxt 3 Deployment](https://v3.nuxtjs.org/getting-started/deployment) documentation.
Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,10 @@ A lightweight Nuxt theme to build a Markdown driven website, based on [Nuxt Cont
99
## Features
1010

1111
::list
12-
- [Document-Driven Mode](https://content.nuxtjs.org/guide/writing/document-driven)
13-
::list{icon="ph:check-circle-light"}
14-
- Create pages in Markdown in the `content/` directory
15-
- Use Nuxt layouts in your Markdown pages
16-
- Enjoy meta tag generation from Markdown files
17-
- Generated navigation based on your pages
18-
::
12+
- Create pages in Markdown in the `content/` directory
13+
- Use Nuxt layouts in your Markdown pages
14+
- Enjoy meta tag generation from Markdown files
15+
- Generated navigation based on your pages
1916
- Switch between Light & Dark mode :moon:
2017
- Access 100,000 icons from 100+ icon sets with the `<Icon>` component
2118
- Highlight code blocks with [Shiki](https://shiki.matsu.io)
File renamed without changes.

template/nuxt.config.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export default defineNuxtConfig({
2+
extends: 'content-wind'
3+
})

template/package.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"private": true,
3+
"scripts": {
4+
"dev": "nuxi dev",
5+
"build": "nuxi build",
6+
"generate": "nuxi generate",
7+
"preview": "nuxi preview"
8+
},
9+
"devDependencies": {
10+
"content-wind": "latest",
11+
"nuxt": "^3.0.0-rc.11"
12+
}
13+
}

0 commit comments

Comments
 (0)