Skip to content
Snippets Groups Projects
Verified Commit 94dfd1cd authored by Georg Krause's avatar Georg Krause
Browse files

Bootstrap documentation

parent c858d7c1
No related branches found
No related tags found
No related merge requests found
...@@ -3,7 +3,6 @@ node_modules ...@@ -3,7 +3,6 @@ node_modules
/dist /dist
/coverage /coverage
# local env files # local env files
.env.local .env.local
.env.*.local .env.*.local
...@@ -22,3 +21,6 @@ pnpm-debug.log* ...@@ -22,3 +21,6 @@ pnpm-debug.log*
*.njsproj *.njsproj
*.sln *.sln
*.sw? *.sw?
# vitepress
src/.vitepress/dist
...@@ -7,7 +7,12 @@ yarn install ...@@ -7,7 +7,12 @@ yarn install
### Compiles and hot-reloads for development ### Compiles and hot-reloads for development
``` ```
yarn serve yarn dev
```
### Preview Production build
```
yarn preview
``` ```
### Compiles and minifies for production ### Compiles and minifies for production
...@@ -17,13 +22,12 @@ yarn build ...@@ -17,13 +22,12 @@ yarn build
### Run your unit tests ### Run your unit tests
``` ```
yarn test:unit yarn test
``` ```
### Lints and fixes files ### Documentation commands
``` ```
yarn lint yarn docs:dev
yarn docs:build
yarn docs:serve
``` ```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
...@@ -6,7 +6,10 @@ ...@@ -6,7 +6,10 @@
"dev": "vite", "dev": "vite",
"build": "vue-tsc --noEmit && vite build", "build": "vue-tsc --noEmit && vite build",
"preview": "vite preview", "preview": "vite preview",
"test": "vitest run --coverage" "test": "vitest run --coverage",
"docs:dev": "vitepress dev src",
"docs:build": "vitepress build src",
"docs:serve": "vitepress serve src"
}, },
"dependencies": { "dependencies": {
"@funkwhale/ui": "0.1.2-dev1", "@funkwhale/ui": "0.1.2-dev1",
...@@ -20,6 +23,7 @@ ...@@ -20,6 +23,7 @@
"sass": "^1.49.7", "sass": "^1.49.7",
"typescript": "^4.4.4", "typescript": "^4.4.4",
"vite": "^2.7.2", "vite": "^2.7.2",
"vitepress": "^0.21.6",
"vitest": "^0.2.8", "vitest": "^0.2.8",
"vue-tsc": "^0.29.8" "vue-tsc": "^0.29.8"
} }
......
module.exports = {
title: "Funkwhale Vue Components",
themeConfig: {
nav: [
{ text: "Home", link: "https://funkwhale.audio" },
{ text: "Gitlab", link: "https://dev.funkwhale.audio" },
],
sidebar: [
{ text: "Components", link: "/components/index" },
],
},
};
# Funkwhale Button
[FunkwhaleButton](FunkwhaleButton)
# Hello VitePress
[[toc]]
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment