-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
680 additions
and
77 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Device Firmware", | ||
"label": "Firmware", | ||
"position": 1, | ||
"collapsed": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/hardware/addons/_category_.json → ...ardware/extension-modules/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Addon Modules", | ||
"label": "Extension Modules", | ||
"position": 2, | ||
"collapsed": false | ||
} |
File renamed without changes.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Doc Playground", | ||
"position": 99 | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
# Docusaurus | ||
|
||
Location to showcase features and examples for writing content in this doc with is based on Docusaurus. | ||
|
||
* [**Official Docs**](https://docusaurus.io/docs) | ||
|
||
<Image alt='Docusaurus' | ||
img={require('@site/static/img/docusaurus.png')} | ||
style={{width:'10%',paddingTop:'10px',paddingBottom:'20px'}} | ||
/> | ||
|
||
```jsx title="Include images with absolute paths and CamelCase css styles" | ||
<Image alt='Docusaurus' | ||
img={require('@site/static/img/docusaurus.png')} | ||
style={{width:'10%',paddingTop:'10px',paddingBottom:'20px'}} /> | ||
``` | ||
## Images | ||
|
||
<Image alt='A dangerous plant' | ||
img={require('./img/plant.jpg')} | ||
style={{width:'75%',padding:'20px'}} /> | ||
|
||
```jsx title="Include images with relative paths" | ||
<Image alt='A dangerous plant' | ||
img={require('./img/plant.jpg')} | ||
style={{width:'85%',padding:'10px'}} /> | ||
``` | ||
|
||
:::info | ||
Images get automatically resized by Docusaurus and must not resized manually to support faster loading of the static | ||
page. The original plant image is 4.5 MB in size, Docusaurus' ideal-image plugin reduced the size to 272 kB. This | ||
mechanism also depends on the requested width. | ||
::: | ||
|
||
## Code Blocks | ||
* [Docusaurus Doc](https://docusaurus.io/docs/markdown-features/code-blocks) | ||
* [Supported Languages](https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/generate-prism-languages/index.ts#L9-L23) | ||
|
||
````md title="Code block for plant image" | ||
```jsx title="Include images with relative paths" | ||
<Image alt='A dangerous plant' | ||
img={require('./img/plant.jpg')} | ||
style={{width:'85%',padding:'10px'}} /> | ||
``` | ||
```` | ||
|
||
## Admonitions | ||
|
||
:::note | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::tip | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::info | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::warning | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::danger | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
```markdown title="Admonitions" | ||
:::note | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::tip | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::info | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::warning | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
|
||
:::danger | ||
Some **content** with _Markdown_ `syntax`. Check [this `api`](#). | ||
::: | ||
``` | ||
|
||
## Tabs | ||
<Tabs> | ||
<TabItem value="apple" label="Apple" default> | ||
This is an apple 🍎 | ||
</TabItem> | ||
<TabItem value="orange" label="Orange"> | ||
This is an orange 🍊 | ||
</TabItem> | ||
<TabItem value="banana" label="Banana"> | ||
This is a banana 🍌 | ||
</TabItem> | ||
</Tabs> | ||
|
||
```jsx title="Tabs" | ||
<Tabs> | ||
<TabItem value="apple" label="Apple" default> | ||
This is an apple 🍎 | ||
</TabItem> | ||
<TabItem value="orange" label="Orange"> | ||
This is an orange 🍊 | ||
</TabItem> | ||
<TabItem value="banana" label="Banana"> | ||
This is a banana 🍌 | ||
</TabItem> | ||
</Tabs> | ||
``` | ||
|
||
|
||
|
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,20 @@ const config: Config = { | |
locales: ['en'], | ||
}, | ||
|
||
plugins: [ | ||
[ | ||
'@docusaurus/plugin-ideal-image', | ||
{ | ||
name: 'assets/images/ideal-img/[name].[hash:hex:7].[width].[ext]', | ||
quality: 85, | ||
max: 1000, // max resized image's size. | ||
min: 600, // min resized image's size. if original is lower, use that size. | ||
steps: 2, // the max number of images generated between min and max (inclusive) | ||
disableInDev: false, | ||
}, | ||
], | ||
], | ||
|
||
presets: [ | ||
[ | ||
'classic', | ||
|
@@ -41,13 +55,6 @@ const config: Config = { | |
editUrl: 'https://github.com/lobaro/iot/tree/master', | ||
}, | ||
blog: false, | ||
/* blog: { | ||
showReadingTime: true, | ||
// Please change this to your repo. | ||
// Remove this to remove the "edit this page" links. | ||
editUrl: | ||
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', | ||
},*/ | ||
theme: { | ||
customCss: './src/css/custom.css', | ||
}, | ||
|
@@ -75,56 +82,6 @@ const config: Config = { | |
width: '120px' | ||
}, | ||
items: [ | ||
/* | ||
{ | ||
type: 'docSidebar', | ||
sidebarId: 'productsSidebar', | ||
position: 'left', | ||
label: 'All Products', | ||
},*/ | ||
/* | ||
{ | ||
type: 'dropdown', | ||
label: 'Community', | ||
position: 'right', | ||
items: [ | ||
{ | ||
label: 'Facebook', | ||
href: 'https://www.facebook.com', | ||
}, | ||
{ | ||
type: 'doc', | ||
label: 'Modbus', | ||
docId: 'knowledge-base/modbus', | ||
}, | ||
// ... more items | ||
], | ||
}, | ||
{ | ||
type: 'html', | ||
position: 'right', | ||
value: '<button>Give feedback</button>', | ||
},*/ | ||
/* | ||
{ | ||
type: 'dropdown', | ||
label: 'Products', | ||
position: 'left', | ||
items: [ | ||
{ | ||
type: 'doc', | ||
label: 'Metering Gateways', | ||
docId: 'products/metering-gateways/index', | ||
}, | ||
{ | ||
type: 'doc', | ||
label: 'Sensor Gateways', | ||
docId: 'products/sensor-gateways/index', | ||
}, | ||
// ... more items | ||
], | ||
}, | ||
*/ | ||
{ | ||
type: 'docSidebar', | ||
sidebarId: 'productsSidebar', | ||
|
@@ -176,11 +133,12 @@ const config: Config = { | |
], | ||
}, | ||
footer: { | ||
copyright: `Copyright © <a href="https://www.lobaro.de" target="_blank">Lobaro GmbH</a> ${new Date().getFullYear()} | Stadtdeich 7 | D-20097 Hamburg | Germany | <a href="mailto:[email protected]">[email protected]</a> | <a href="https://www.lobaro.com/en/contact/" target="_blank">Legal Disclosure</a>` | ||
copyright: `<div style="font-size: small">Copyright © <a href="https://www.lobaro.de" target="_blank">Lobaro GmbH</a> ${new Date().getFullYear()} | Stadtdeich 7 | D-20097 Hamburg | Germany | <a href="mailto:[email protected]">[email protected]</a> | <a href="https://www.lobaro.com/en/contact/" target="_blank">Legal Disclosure</a></div>` | ||
}, | ||
prism: { | ||
theme: prismThemes.github, | ||
darkTheme: prismThemes.dracula, | ||
// additionalLanguages: ['js','c'], // https://prismjs.com/#supported-languages | ||
}, | ||
} satisfies Preset.ThemeConfig, | ||
}; | ||
|
Oops, something went wrong.