Skip to content

Commit

Permalink
[DOCS] Factorize configuration (#218)
Browse files Browse the repository at this point in the history
  • Loading branch information
1technophile authored Jan 9, 2024
1 parent 5dd678c commit 4c73555
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 67 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ jobs:
python -m pip install --upgrade pip
pip install requests
npm install
- name: Download Common Config
run: |
curl -o docs/.vuepress/public/commonConfig.js https://www.theengs.io/commonConfig.js
- name: Build documentation
run: |
npm run docs:build
Expand Down
94 changes: 27 additions & 67 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,69 +1,29 @@
const commonConfig = require('./public/commonConfig');

module.exports = {
markdown: {
lineNumbers: true
},
title: 'Theengs gateway',
description: 'Multi platform MQTT BLE gateway leveraging Theengs Decoder',
head: [
['link', { rel: "apple-touch-icon", sizes: "180x180", href: ".apple-touch-icon.png"}],
['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/favicon-32x32.png"}],
['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/favicon-16x16.png"}],
['link', { rel: 'manifest', href: '/manifest.json' }],
['meta', { name: 'theme-color', content: '#3eaf7c' }],
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }],
['meta', { name: 'msapplication-TileImage', content: '/favicon-144x144.png' }],
['meta', { name: 'msapplication-TileColor', content: '#000000' }]
],
themeConfig: {
smoothScroll: true,
repo: 'theengs/gateway',
docsDir: 'docs',
docsBranch: 'development',
lastUpdated: 'Last Updated',
editLinks: true,
nav: [
{ text: 'Shop', link: 'https://shop.theengs.io/'},
{ text: 'Home', link: 'https://www.theengs.io', target:'_self', rel:''},
{ text: 'Use cases',
items: [
{ text: 'Smart Home', link: 'https://www.theengs.io/usecases/smarthome.html', target:'_self', rel:''},
{ text: 'Research', link: 'https://www.theengs.io/usecases/research.html', target:'_self', rel:''}
]},
{ text: 'Compatible', link: 'https://decoder.theengs.io/devices/devices.html', target:'_self', rel:''},
{ text: 'App', link: 'https://app.theengs.io', target:'_self', rel:''},
{ text: 'Gateway', link: 'https://gateway.theengs.io', target:'_self', rel:''},
{ text: 'Decoder', link: 'https://decoder.theengs.io', target:'_self', rel:''},
{ text: 'Web Parser', link: 'https://parser.theengs.io', target:'_self', rel:''}
],
sidebar: [
['/','0 - What is it for 🏠'],
{
title: '1 - Prerequisites🧭',
children: [
'prerequisites/hardware',
'prerequisites/broker',
'prerequisites/controller']
},
['/install/install','2 - Install ✔️'],
['/use/use','3 - Use ✈️'],
{
title: '4 - Participate 💻',
children: [
'participate/adding-decoders',
'participate/support',
'participate/development'
]
}
]
},
plugins: [
['@vuepress/pwa', {
serviceWorker: true,
updatePopup: true
}],
['@vuepress/medium-zoom', true],
['@vuepress/nprogress']
]
...commonConfig,
themeConfig: {
repo: 'theengs/gateway',
...commonConfig.themeConfig,
sidebar: [
['/','0 - What is it for 🏠'],
{
title: '1 - Prerequisites🧭',
children: [
'prerequisites/hardware',
'prerequisites/broker',
'prerequisites/controller']
},
['/install/install','2 - Install ✔️'],
['/use/use','3 - Use ✈️'],
{
title: '4 - Participate 💻',
children: [
'participate/adding-decoders',
'participate/support',
'participate/development'
]
}
]
}
}

0 comments on commit 4c73555

Please sign in to comment.