Bootstrap documentation

.gitignore

@@ -3,7 +3,6 @@ node_modules
 /dist
 /coverage
 
-
 # local env files
 .env.local
 .env.*.local
@@ -22,3 +21,6 @@ pnpm-debug.log*
 *.njsproj
 *.sln
 *.sw?
+
+# vitepress
+src/.vitepress/dist

README.md

@@ -7,7 +7,12 @@ yarn install
 
 ### Compiles and hot-reloads for development
 ```
-yarn serve
+yarn dev
+```
+
+### Preview Production build
+```
+yarn preview
 ```
 
 ### Compiles and minifies for production
@@ -17,13 +22,12 @@ yarn build
 
 ### 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/).

package.json

 {
-  "name": "vui",
-  "version": "0.0.0",
-  "license": "AGPL-3.0-or-later",
-  "scripts": {
-    "dev": "vite",
-    "build": "vue-tsc --noEmit && vite build",
-    "preview": "vite preview",
-    "test": "vitest run --coverage"
-  },
-  "dependencies": {
-    "@funkwhale/ui": "0.1.2-dev1",
-    "vue": "^3.2.25"
-  },
-  "devDependencies": {
-    "@testing-library/vue": "^6.4.2",
-    "@vitejs/plugin-vue": "^2.0.0",
-    "c8": "^7.11.0",
-    "happy-dom": "^2.31.1",
-    "sass": "^1.49.7",
-    "typescript": "^4.4.4",
-    "vite": "^2.7.2",
-    "vitest": "^0.2.8",
-    "vue-tsc": "^0.29.8"
-  }
+	"name": "vui",
+	"version": "0.0.0",
+	"license": "AGPL-3.0-or-later",
+	"scripts": {
+		"dev": "vite",
+		"build": "vue-tsc --noEmit && vite build",
+		"preview": "vite preview",
+		"test": "vitest run --coverage",
+		"docs:dev": "vitepress dev src",
+		"docs:build": "vitepress build src",
+		"docs:serve": "vitepress serve src"
+	},
+	"dependencies": {
+		"@funkwhale/ui": "0.1.2-dev1",
+		"vue": "^3.2.25"
+	},
+	"devDependencies": {
+		"@testing-library/vue": "^6.4.2",
+		"@vitejs/plugin-vue": "^2.0.0",
+		"c8": "^7.11.0",
+		"happy-dom": "^2.31.1",
+		"sass": "^1.49.7",
+		"typescript": "^4.4.4",
+		"vite": "^2.7.2",
+		"vitepress": "^0.21.6",
+		"vitest": "^0.2.8",
+		"vue-tsc": "^0.29.8"
+	}
 }

src/.vitepress/config.ts

+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" },
+		],
+	},
+};

src/components/FunkwhaleButton.md

+# Funkwhale Button

src/components/index.md

+[FunkwhaleButton](FunkwhaleButton)

src/index.md

+# Hello VitePress
+
+[[toc]]