Skip to content

Commit dd5f726

Browse files
committed
docs: starts a vuepress site for documentation
1 parent e67f505 commit dd5f726

File tree

6 files changed

+3223
-117
lines changed

6 files changed

+3223
-117
lines changed

docs/.vuepress/config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
title: 'App Config',
3+
description: 'Easy to use configuration loader with schema validation',
4+
};

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Hello world!

docs/package.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "@lcdev/app-config-docs",
3+
"version": "0.0.0",
4+
"license": "MPL-2.0",
5+
"private": true,
6+
"scripts": {
7+
"dev": "vuepress dev .",
8+
"build": "vuepress build .",
9+
"lint": "exit 0",
10+
"fix": "exit 0",
11+
"test": "exit 0"
12+
},
13+
"dependencies": {
14+
"vuepress": "1"
15+
}
16+
}

netlify.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build]
2+
publish = "docs/.vuepress/dist"
3+
command = "yarn docs:build"

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
"version": "0.0.0",
44
"private": true,
55
"workspaces": [
6+
"docs",
7+
"examples/*",
68
"app-config",
7-
"app-config-webpack-plugin",
8-
"examples/*"
9+
"app-config-webpack-plugin"
910
],
1011
"scripts": {
1112
"cli": "yarn --cwd ./app-config cli",
13+
"docs:build": "yarn --cwd ./docs build",
1214
"build": "yarn workspaces run build",
1315
"clean": "yarn workspaces run clean",
1416
"test": "yarn workspaces run test",

0 commit comments

Comments
 (0)