[DOCS] Factorize documentation configuration into one file (#1856)
This commit is contained in:
1 parent
fd3c9b07b4
commit
2c3d98729a
4 files changed
+14
-25
No files matched your search
@@ -127,6 +127,9 @@ jobs:
|
|||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: "14.x"
|
node-version: "14.x"
|
||||||
|
- name: Download Common Config
|
||||||
|
run: |
|
||||||
|
curl -o docs/.vuepress/public/commonConfig.js https://www.theengs.io/commonConfig.js
|
||||||
- name: Install build dependencies
|
- name: Install build dependencies
|
||||||
run: npm install
|
run: npm install
|
||||||
- name: Build documentation
|
- name: Build documentation
|
||||||
|
|||||||
@@ -54,6 +54,9 @@ jobs:
|
|||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: "14.x"
|
node-version: "14.x"
|
||||||
|
- name: Download Common Config
|
||||||
|
run: |
|
||||||
|
curl -o docs/.vuepress/public/commonConfig.js https://www.theengs.io/commonConfig.js
|
||||||
- name: Build documentation
|
- name: Build documentation
|
||||||
run: |
|
run: |
|
||||||
python ./scripts/gen_wu_dev.py
|
python ./scripts/gen_wu_dev.py
|
||||||
|
|||||||
@@ -21,6 +21,9 @@ jobs:
|
|||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
pip install requests pandas markdown pytablereader tabulate
|
pip install requests pandas markdown pytablereader tabulate
|
||||||
npm install
|
npm install
|
||||||
|
- name: Download Common Config
|
||||||
|
run: |
|
||||||
|
curl -o docs/.vuepress/public/commonConfig.js https://www.theengs.io/commonConfig.js
|
||||||
- name: get lastest release tag
|
- name: get lastest release tag
|
||||||
id: last_release
|
id: last_release
|
||||||
uses: InsonusK/get-latest-release@v1.0.1
|
uses: InsonusK/get-latest-release@v1.0.1
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
|
const commonConfig = require('./public/commonConfig');
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
markdown: {
|
...commonConfig,
|
||||||
lineNumbers: true
|
|
||||||
},
|
|
||||||
title: 'OpenMQTTGateway version_tag',
|
title: 'OpenMQTTGateway version_tag',
|
||||||
base: '/',
|
base: '/',
|
||||||
description: 'One gateway, many technologies: MQTT gateway for ESP8266, ESP32, Sonoff RF Bridge or Arduino with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.',
|
description: 'One gateway, many technologies: MQTT gateway for ESP8266, ESP32, Sonoff RF Bridge or Arduino with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.',
|
||||||
@@ -20,21 +20,9 @@ module.exports = {
|
|||||||
['script', {type: 'module', src: 'https://unpkg.com/esp-web-tools@3.4.2/dist/web/install-button.js?module'}]
|
['script', {type: 'module', src: 'https://unpkg.com/esp-web-tools@3.4.2/dist/web/install-button.js?module'}]
|
||||||
],
|
],
|
||||||
themeConfig: {
|
themeConfig: {
|
||||||
smoothScroll: true,
|
|
||||||
repo: '1technophile/OpenMQTTGateway',
|
repo: '1technophile/OpenMQTTGateway',
|
||||||
docsDir: 'docs',
|
docsDir: 'docs',
|
||||||
docsBranch: 'development',
|
...commonConfig.themeConfig,
|
||||||
lastUpdated: 'Last Updated',
|
|
||||||
editLinks: true,
|
|
||||||
nav: [
|
|
||||||
{ text: 'Shop🆕', link: 'https://shop.theengs.io/'},
|
|
||||||
{ text: 'Blog', link: 'https://1technophile.blogspot.com'},
|
|
||||||
{ text: 'Docs', link: '/'},
|
|
||||||
{ text: 'Community', link: 'https://community.openmqttgateway.com', target:'_self', rel:''},
|
|
||||||
{ text: 'Devices', link: 'https://compatible.openmqttgateway.com/index.php/devices', target:'_self', rel:''},
|
|
||||||
{ text: 'Upload', link: '/upload/web-install.html'},
|
|
||||||
{ text: 'Theengs', link: 'https://app.theengs.io/'}
|
|
||||||
],
|
|
||||||
sidebar: [
|
sidebar: [
|
||||||
['/','0 - What is it for 🏠'],
|
['/','0 - What is it for 🏠'],
|
||||||
{
|
{
|
||||||
@@ -118,13 +106,5 @@ module.exports = {
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
|
||||||
plugins: [
|
|
||||||
['@vuepress/pwa', {
|
|
||||||
serviceWorker: true,
|
|
||||||
updatePopup: true
|
|
||||||
}],
|
|
||||||
['@vuepress/medium-zoom', true],
|
|
||||||
['@vuepress/nprogress']
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user