Add VuePress for docs

This commit is contained in:
Christian W. Zuckschwerdt 2019-08-27 11:58:48 +00:00
parent 25c90555d9
commit 3a762731c1
4 changed files with 61 additions and 0 deletions

10
docs/.gitignore vendored Normal file
View file

@ -0,0 +1,10 @@
# ignore VuePress build files
.vuepress/dist
node_modules
yarn.lock
# ignore copied files
README.md
CHANGELOG.md
EXAMPLES.md
TESTS.md
VS15.md

21
docs/.vuepress/config.js Normal file
View file

@ -0,0 +1,21 @@
module.exports = {
title: 'rtl_433',
description: 'generic data receiver for ISM/SRD bands.',
base: "/rtl_433/",
markdown: {
linkify: true
},
themeConfig: {
repo: 'merbanan/rtl_433',
displayAllHeaders: true,
sidebar: [
['/', 'Overview'],
'BUILDING',
'CHANGELOG',
'DATA_FORMAT',
'EXAMPLES',
'TESTS',
'VS15'
]
}
};

18
docs/build-docs.sh Executable file
View file

@ -0,0 +1,18 @@
#!/bin/sh
# abort on errors
set -e
# navigate to the docs directory
cd ${0%/*}
# copy other docs
sed 's/docs\///' ../README.md >README.md
cp ../CHANGELOG.md .
cp ../examples/README.md EXAMPLES.md
cp ../rtl_433_tests/README.md TESTS.md
cp ../vs15/README.md VS15.md
# build
yarn install
yarn docs:build

12
docs/package.json Normal file
View file

@ -0,0 +1,12 @@
{
"name": "rtl_433-docs",
"version": "1.0.0",
"private": true,
"scripts": {
"docs:dev": "vuepress dev",
"docs:build": "vuepress build"
},
"devDependencies": {
"vuepress": "^0.14.11"
}
}