Browse Source

Cleanup

master
Riyyi 2 weeks ago
parent
commit
6ac81c61d9
  1. 52
      README.org
  2. 35
      package-lock.json
  3. 2
      package.json
  4. 4
      src/components/ColorMode.vue

52
README.org

@ -9,7 +9,7 @@ Website, written in Typescript.
Install dependencies:
#+BEGIN_SRC sh
$ bun install
$ npm install
#+END_SRC
** Development Server
@ -17,8 +17,8 @@ $ bun install
Start the development server on =http://localhost:3000=:
#+BEGIN_SRC sh
$ bun run dev
$ bun run dev -o # automatically open in the browser
$ npm run dev
$ npm run dev -- -o # automatically open in the browser
#+END_SRC
** Production
@ -26,14 +26,14 @@ $ bun run dev -o # automatically open in the browser
Build for production:
#+BEGIN_SRC sh
$ bun run build # for server-side rendering or hybrid
$ bun run generate # for static site generation
$ npm run build # for server-side rendering or hybrid
$ npm run generate # for static site generation
#+END_SRC
Locally preview production build:
#+BEGIN_SRC sh
$ bun run preview # requires building first!
$ npm run preview # requires building first!
#+END_SRC
Reference: [[https://nuxt.com/docs/getting-started/deployment#client-side-only-rendering][nuxt/docs/deployment#client-side-only-rendering]]
@ -43,38 +43,18 @@ Reference: [[https://nuxt.com/docs/getting-started/deployment#client-side-only-r
- [[https://github.com/vuejs/core][Vue3]] JavaScript framework
- [[https://github.com/nuxt/nuxt][Nuxt]] Vue framework
- [[https://github.com/vuejs/pinia][Pinia]] State management
- [[https://github.com/primefaces/primevue][PrimeVue]] Vue component library
- [[https://github.com/twbs/bootstrap][Bootstrap5]] CSS library
- [[https://github.com/colinhacks/zod][Zod]] Schema validation
- [[https://github.com/microsoft/TypeScript][Typescript]] Static types in JavaScript
- [[https://github.com/eslint/eslint][ESLint]] Code analyses tool
** Package Reproduction
* Todo
The following bun commands have been run to fill the =package.json=:
#+BEGIN_SRC sh
$ bun x nuxi@latest init website
# Development
$ bun nuxi module add eslint
$ bun install --dev typescript
$ bun install --dev @vue/language-server
$ bun install --dev @vue/typescript-plugin
$ bun install -g typescript
$ bun install -g @vue/language-server
$ bun install -g @vue/typescript-plugin
# Pinia
$ bun install @pinia/nuxt # also add it to nuxt.config modules!
$ bun install pinia-plugin-persistedstate # same as above
# PrimeVue
$ bun install primevue primeicons @primevue/themes @primevue/forms
$ bun install --dev @primevue/nuxt-module
# Zod
$ bun install zod
# UUID
$ bun install uuid
#+END_SRC
- [ ] dark-mode
- [ ] persistence in localstorage
- [X] <h> tag scroll fix
- [ ] pull request? https://github.com/nuxt-modules/mdc/tree/main/src/runtime/components/prose
- [X] table of contents: https://github.com/hanyujie2002/nuxt-toc/blob/main/src/runtime/components/TableOfContents.vue
- [X] nuke: bootstrap-vue-next
- [ ] update readme: bun -> npm, primevue -> bootstrap
- [X] better popup code copy button

35
package-lock.json generated

@ -23,8 +23,6 @@
"@nuxt/content": "^3.4.0",
"@nuxt/eslint": "^1.2.0",
"@types/bootstrap": "^5.2.10",
"@types/bun": "latest",
"@vue/compiler-sfc": "^3.5.13",
"@vue/language-server": "^2.1.10",
"@vue/typescript-plugin": "^2.1.10",
"nuxt": "^3.14.1592",
@ -2258,16 +2256,6 @@
"@popperjs/core": "^2.9.2"
}
},
"node_modules/@types/bun": {
"version": "1.2.8",
"resolved": "https://registry.npmjs.org/@types/bun/-/bun-1.2.8.tgz",
"integrity": "sha512-t8L1RvJVUghW5V+M/fL3Thbxcs0HwNsXsnTEBEfEVqGteiJToOlZ/fyOEaR1kZsNqnu+3XA4RI/qmnX4w6+S+w==",
"dev": true,
"license": "MIT",
"dependencies": {
"bun-types": "1.2.7"
}
},
"node_modules/@types/debug": {
"version": "4.1.12",
"dev": true,
@ -2315,6 +2303,8 @@
"version": "22.13.14",
"dev": true,
"license": "MIT",
"optional": true,
"peer": true,
"dependencies": {
"undici-types": "~6.20.0"
}
@ -2339,14 +2329,6 @@
"dev": true,
"license": "MIT"
},
"node_modules/@types/ws": {
"version": "8.18.0",
"dev": true,
"license": "MIT",
"dependencies": {
"@types/node": "*"
}
},
"node_modules/@typescript-eslint/eslint-plugin": {
"version": "8.28.0",
"dev": true,
@ -3552,15 +3534,6 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/bun-types": {
"version": "1.2.7",
"dev": true,
"license": "MIT",
"dependencies": {
"@types/node": "*",
"@types/ws": "*"
}
},
"node_modules/bundle-name": {
"version": "4.1.0",
"dev": true,
@ -11233,7 +11206,9 @@
"node_modules/undici-types": {
"version": "6.20.0",
"dev": true,
"license": "MIT"
"license": "MIT",
"optional": true,
"peer": true
},
"node_modules/unenv": {
"version": "2.0.0-rc.15",

2
package.json

@ -26,8 +26,6 @@
"@nuxt/content": "^3.4.0",
"@nuxt/eslint": "^1.2.0",
"@types/bootstrap": "^5.2.10",
"@types/bun": "latest",
"@vue/compiler-sfc": "^3.5.13",
"@vue/language-server": "^2.1.10",
"@vue/typescript-plugin": "^2.1.10",
"nuxt": "^3.14.1592",

4
src/components/ColorMode.vue

@ -20,13 +20,13 @@
</li>
<li>
<a class="dropdown-item" :class="store.colorMode === 'dark' ? 'active' : ''" @click="store.setColorMode('dark')">
<IFaSolidMoon /> Dark
<IFaSolidMoon /> Dark &nbsp;
<IFaCheck v-if="store.colorMode === 'dark'" class="font-smaller float-right" />
</a>
</li>
<li>
<a class="dropdown-item" :class="store.colorMode === 'auto' ? 'active' : ''" @click="store.setColorMode('auto')">
<IFaAdjust width="1.3em" /> Auto
<IFaAdjust width="1.3em" /> Auto &nbsp;
<IFaCheck v-if="store.colorMode === 'auto'" class="font-smaller float-right" />
</a>
</li>

Loading…
Cancel
Save