Add basic Guider project and remove Nuxt content

This commit is contained in:
mrjvs 2024-03-30 20:22:43 +01:00
parent e10040dc40
commit c06bedc93c
18 changed files with 1753 additions and 7291 deletions

View File

@ -1,7 +1,6 @@
dist
node_modules
.output
.nuxt
public
# Ignore index due to prettier removing setext headers
*.index.md

View File

@ -1,8 +1,8 @@
module.exports = {
root: true,
extends: ['@nuxt/eslint-config', 'plugin:prettier/recommended'],
rules: {
'vue/max-attributes-per-line': 'off',
'vue/multi-word-component-names': 'off',
extends: ['plugin:@next/next/recommended', 'plugin:prettier/recommended'],
parserOptions: {
sourceType: 'module',
ecmaVersion: 2020,
},
};

View File

@ -1,71 +1,48 @@
name: Deploy Nuxt site to Pages
name: "docs-deploy"
on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
branches:
- master
jobs:
# Build job
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: pnpm
- name: Setup Pages
uses: actions/configure-pages@v4
#with:
# static_site_generator: nuxt
- name: Restore cache
uses: actions/cache@v4
with:
path: |
dist
.nuxt
key: ${{ runner.os }}-nuxt-build-${{ hashFiles('dist') }}
restore-keys: |
${{ runner.os }}-nuxt-build-
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Static HTML export with Nuxt
run: pnpm generate
env:
NUXT_APP_BASE_URL: /docs/
- name: Upload artifact
- name: Build
run: pnpm build
- name: Upload
uses: actions/upload-pages-artifact@v3
with:
path: ./dist
path: ./out
# Deployment job
deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment

4
.gitignore vendored
View File

@ -2,11 +2,11 @@ node_modules
*.iml
.idea
*.log*
.nuxt
.vscode
.DS_Store
coverage
dist
sw.*
.env
.output
out
.next

1
.npmrc
View File

@ -1 +0,0 @@
shamefully-hoist=true

View File

@ -1,32 +0,0 @@
export default defineAppConfig({
docus: {
title: 'movie-web',
description:
'movie-web is a free and open source streaming site, no ads, no tracking, no nonsense.',
url: 'https://movie-web.github.io/docs',
image: '/docs/cover.png',
socials: {
github: 'movie-web/movie-web',
},
github: {
repo: 'docs',
owner: 'movie-web',
branch: 'master',
dir: 'content',
},
aside: {
level: 0,
exclude: [],
},
header: {
logo: true,
},
footer: {
credits: {
icon: '',
text: 'Made with 💜',
href: 'https://github.com/movie-web',
},
},
},
});

5
next-env.d.ts vendored Normal file
View File

@ -0,0 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.

12
next.config.mjs Normal file
View File

@ -0,0 +1,12 @@
import { guider } from '@neato/guider';
const withGuider = guider({
// The location of your theme file, created in the next step
themeConfig: './theme.config.tsx',
});
export default withGuider({
// These are the normal Next.JS settings.
// Check out Next.JS docs: https://nextjs.org/docs/app/api-reference/next-config-js
output: 'export',
});

View File

@ -1,11 +0,0 @@
export default defineNuxtConfig({
// https://github.com/nuxt-themes/docus
extends: '@nuxt-themes/docus',
devtools: { enabled: true },
app: {
head: {
link: [{ rel: 'icon', type: 'image/x-icon', href: '/docs/favicon.ico' }],
},
},
});

View File

@ -1,25 +1,27 @@
{
"name": "docus-starter",
"version": "0.1.0",
"name": "movie-web-docs",
"version": "0.2.0",
"private": true,
"scripts": {
"dev": "nuxi dev",
"build": "nuxi build",
"generate": "nuxi generate",
"preview": "nuxi preview",
"lint": "eslint .",
"lint:fix": "eslint --fix ."
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint",
"lint:fix": "next lint --fix"
},
"devDependencies": {
"@nuxt-themes/docus": "latest",
"@nuxt/devtools": "^1.0.6",
"@nuxt/eslint-config": "^0.2.0",
"@nuxtjs/plausible": "^0.2.4",
"@types/node": "^20.10.6",
"@next/eslint-plugin-next": "^14.1.4",
"@types/react": "18.2.73",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.2",
"nuxt": "^3.9.0",
"prettier": "^3.1.1"
"prettier": "^3.1.1",
"typescript": "5.4.3"
},
"dependencies": {
"@neato/guider": "^0.1.3",
"next": "^14.1.4",
"react": "^18.2.0",
"react-dom": "^18.2.0"
}
}

3
pages/404.tsx Normal file
View File

@ -0,0 +1,3 @@
import { createNotFoundPage } from '@neato/guider/client';
export default createNotFoundPage();

4
pages/_app.tsx Normal file
View File

@ -0,0 +1,4 @@
import '@neato/guider/style.css';
import { createGuiderApp } from '@neato/guider/client';
export default createGuiderApp();

2
pages/index.mdx Normal file
View File

@ -0,0 +1,2 @@
# Hello world
This is my first `@neato/guider` page!

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +0,0 @@
{
"extends": ["@nuxtjs"],
"lockFileMaintenance": {
"enabled": true
}
}

12
theme.config.tsx Normal file
View File

@ -0,0 +1,12 @@
import { defineTheme, directory, link } from '@neato/guider/theme';
export default defineTheme({
directories: [
directory("main", { // ID of your directory (unique per site), used for referencing in your page files
sidebar: [
// Creates a link in your sidebar, add more below it
link("Home", "/")
]
})
],
});

View File

@ -1,18 +0,0 @@
import { defineTheme } from 'pinceau';
export default defineTheme({
color: {
primary: {
50: '#F5E5FF',
100: '#E7CCFF',
200: '#D4A9FF',
300: '#BE85FF',
400: '#A861FF',
500: '#8E3DFF',
600: '#7F36D4',
700: '#662CA6',
800: '#552578',
900: '#441E49',
},
},
});

View File

@ -1,3 +1,28 @@
{
"extends": "./.nuxt/tsconfig.json"
"compilerOptions": {
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"strict": false,
"noEmit": true,
"incremental": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "Bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve"
},
"include": [
"next-env.d.ts",
"**/*.ts",
"**/*.tsx"
],
"exclude": [
"node_modules"
]
}