init
This commit is contained in:
commit
dca70d7028
16 changed files with 3397 additions and 0 deletions
5
.editorconfig
Normal file
5
.editorconfig
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
tab_width = 2
|
||||||
|
indent_size = 2
|
||||||
|
indent_style = space
|
||||||
25
.gitignore
vendored
Normal file
25
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
node_modules
|
||||||
|
dist
|
||||||
|
dist-ssr
|
||||||
|
*.local
|
||||||
|
/content
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/extensions.json
|
||||||
|
.idea
|
||||||
|
.DS_Store
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
||||||
|
*.sw?
|
||||||
3
.vscode/extensions.json
vendored
Normal file
3
.vscode/extensions.json
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
{
|
||||||
|
"recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
|
||||||
|
}
|
||||||
18
README.md
Normal file
18
README.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# Vue 3 + TypeScript + Vite
|
||||||
|
|
||||||
|
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
|
||||||
|
|
||||||
|
## Recommended IDE Setup
|
||||||
|
|
||||||
|
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
|
||||||
|
|
||||||
|
## Type Support For `.vue` Imports in TS
|
||||||
|
|
||||||
|
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
|
||||||
|
|
||||||
|
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
|
||||||
|
|
||||||
|
1. Disable the built-in TypeScript Extension
|
||||||
|
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
|
||||||
|
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
|
||||||
|
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
|
||||||
13
index.html
Normal file
13
index.html
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Vite + Vue + TS</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="app"></div>
|
||||||
|
<script type="module" src="/src/main.ts"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
3175
package-lock.json
generated
Normal file
3175
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
36
package.json
Normal file
36
package.json
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
{
|
||||||
|
"name": "static-web-templates",
|
||||||
|
"private": true,
|
||||||
|
"version": "0.0.0",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"start": "vite",
|
||||||
|
"build": "vue-tsc && vite-ssg build",
|
||||||
|
"preview": "vite preview"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/dompurify": "3.0.5",
|
||||||
|
"@types/js-yaml": "4.0.9",
|
||||||
|
"@types/node": "18.16.x",
|
||||||
|
"@unhead/vue": "1.8.12",
|
||||||
|
"@vitejs/plugin-vue": "5.0.4",
|
||||||
|
"dompurify": "3.0.9",
|
||||||
|
"github-slugger": "2.0.0",
|
||||||
|
"highlight.js": "11.9.0",
|
||||||
|
"js-yaml": "4.1.0",
|
||||||
|
"marked": "12.0.1",
|
||||||
|
"marked-highlight": "2.1.1",
|
||||||
|
"normalize.css": "8.0.1",
|
||||||
|
"pinia": "2.1.7",
|
||||||
|
"pug": "3.0.2",
|
||||||
|
"rfdc": "1.3.1",
|
||||||
|
"sass": "1.71.1",
|
||||||
|
"typescript": "5.4.2",
|
||||||
|
"vite": "5.1.4",
|
||||||
|
"vite-ssg": "0.23.6",
|
||||||
|
"vue": "3.4.19",
|
||||||
|
"vue-router": "4.3.0",
|
||||||
|
"vue-tippy": "6.4.1",
|
||||||
|
"vue-tsc": "1.8.27"
|
||||||
|
}
|
||||||
|
}
|
||||||
11
src/content-env.d.ts
vendored
Normal file
11
src/content-env.d.ts
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
declare module 'content/routes.js' {
|
||||||
|
type Template =
|
||||||
|
| 'markdown'
|
||||||
|
|
||||||
|
type Routes = { [key: string]: {
|
||||||
|
id: string
|
||||||
|
template: Template
|
||||||
|
}}
|
||||||
|
|
||||||
|
const routes: Routes
|
||||||
|
}
|
||||||
15
src/main.ts
Normal file
15
src/main.ts
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
import { ViteSSG } from 'vite-ssg'
|
||||||
|
import './style.css'
|
||||||
|
import main from './main.vue'
|
||||||
|
import { createRoutes } from './routes'
|
||||||
|
|
||||||
|
export const createApp = ViteSSG(
|
||||||
|
// the root component
|
||||||
|
main,
|
||||||
|
// vue-router options
|
||||||
|
{ routes: createRoutes() },
|
||||||
|
// function to have custom setups
|
||||||
|
// ({ app, router, routes, isClient, initialState }) => {
|
||||||
|
// // install plugins etc.
|
||||||
|
// },
|
||||||
|
)
|
||||||
17
src/main.vue
Normal file
17
src/main.vue
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
<script setup lang="ts">
|
||||||
|
|
||||||
|
const ready = true
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template lang="pug">
|
||||||
|
#main-container
|
||||||
|
#main-entry(
|
||||||
|
v-if='ready'
|
||||||
|
)
|
||||||
|
main
|
||||||
|
router-view
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="sass">
|
||||||
|
|
||||||
|
</style>
|
||||||
22
src/routes.ts
Normal file
22
src/routes.ts
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
import { type RouteRecordRaw } from 'vue-router'
|
||||||
|
import { routes, type Template } from 'content/routes.js'
|
||||||
|
|
||||||
|
const markdownBody = () => import ('./views/markdown.vue')
|
||||||
|
|
||||||
|
export const templates: Record<Template, () => Promise<any>> = {
|
||||||
|
'markdown': markdownBody,
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createRoutes = (): RouteRecordRaw[] => {
|
||||||
|
const routeRecord: RouteRecordRaw[] = []
|
||||||
|
|
||||||
|
Object.keys(routes).forEach(route => {
|
||||||
|
routeRecord.push({
|
||||||
|
name: routes[route].id,
|
||||||
|
path: route,
|
||||||
|
component: templates[routes[route].template],
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
return routeRecord
|
||||||
|
}
|
||||||
0
src/style.css
Normal file
0
src/style.css
Normal file
1
src/vite-env.d.ts
vendored
Normal file
1
src/vite-env.d.ts
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
/// <reference types="vite/client" />
|
||||||
31
tsconfig.json
Normal file
31
tsconfig.json
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"baseUrl": "./",
|
||||||
|
"paths": {
|
||||||
|
"content/*": ["./content/*"],
|
||||||
|
"src/*": ["./src/*"]
|
||||||
|
},
|
||||||
|
|
||||||
|
"target": "ES2020",
|
||||||
|
"useDefineForClassFields": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"lib": ["ES2020", "DOM", "DOM.Iterable"],
|
||||||
|
"skipLibCheck": true,
|
||||||
|
|
||||||
|
/* Bundler mode */
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"isolatedModules": true,
|
||||||
|
"noEmit": true,
|
||||||
|
"jsx": "preserve",
|
||||||
|
|
||||||
|
/* Linting */
|
||||||
|
"strict": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"noFallthroughCasesInSwitch": true
|
||||||
|
},
|
||||||
|
"include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"],
|
||||||
|
"references": [{ "path": "./tsconfig.node.json" }]
|
||||||
|
}
|
||||||
11
tsconfig.node.json
Normal file
11
tsconfig.node.json
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"composite": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"strict": true
|
||||||
|
},
|
||||||
|
"include": ["vite.config.ts"]
|
||||||
|
}
|
||||||
14
vite.config.ts
Normal file
14
vite.config.ts
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
import { defineConfig } from 'vite'
|
||||||
|
import vue from '@vitejs/plugin-vue'
|
||||||
|
import path from 'path'
|
||||||
|
|
||||||
|
// https://vitejs.dev/config/
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [vue()],
|
||||||
|
resolve: {
|
||||||
|
alias: {
|
||||||
|
'content': path.resolve(__dirname, './content'),
|
||||||
|
'src': path.resolve(__dirname, './src'),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
Loading…
Add table
Reference in a new issue