forked from hacs/documentation
-
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
10 changed files
with
147 additions
and
66 deletions.
There are no files selected for viewing
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,15 @@ | ||
--- | ||
id: developer_documentation | ||
title: Developer documentation | ||
description: 'Everything HACS for publishers.' | ||
sidebar_position: 0 | ||
--- | ||
|
||
Hi there :wave: | ||
|
||
This is the beginning of the developer documentation. | ||
|
||
Use the sidebar to navigate this section. | ||
|
||
- [If you are looking for how to use HACS have a look at the user documentation](/docs/user) | ||
- [If you are looking for how to publish something that can be tracked by HACS have a look at the publisher documentation](/docs/publisher) |
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
id: faq_entry | ||
title: Frequently Asked Questions | ||
description: "Everything might not be frequently asked, but it's a good dumping ground for various information." | ||
sidebar_position: 0 | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList' | ||
import { useCurrentSidebarCategory } from '@docusaurus/theme-common' | ||
|
||
<i>{frontMatter.description}</i> | ||
|
||
<DocCardList items={useCurrentSidebarCategory().items} /> |
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,15 @@ | ||
--- | ||
id: publisher_documentation | ||
title: Publisher documentation | ||
description: 'Everything HACS for publishers.' | ||
sidebar_position: 0 | ||
--- | ||
|
||
Hi there :wave: | ||
|
||
This is the beginning of the publisher documentation. | ||
|
||
Use the sidebar to navigate this section. | ||
|
||
- [If you are looking for how to use HACS have a look at the user documentation](/docs/user) | ||
- [If you are looking for how to develop/change something for HACS itself have a look at the developer documentation](/docs/developer) |
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,15 @@ | ||
--- | ||
id: user_documentation | ||
title: User documentation | ||
description: 'Everything HACS for users.' | ||
sidebar_position: 0 | ||
--- | ||
|
||
Hi there :wave: | ||
|
||
This is the beginning of the user documentation. | ||
|
||
Use the sidebar to navigate this section. | ||
|
||
- [If you are looking for how to publish something that can be tracked by HACS have a look at the publisher documentation](/docs/publisher) | ||
- [If you are looking for how to develop/change something for HACS itself have a look at the developer documentation](/docs/developer) |
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,56 +1,87 @@ | ||
module.exports = { | ||
usage: { | ||
Basic: [ | ||
"user": { | ||
"User documentation": [ | ||
{ | ||
type: 'autogenerated', | ||
dirName: 'basic', | ||
} | ||
], | ||
Navigation: [{ | ||
type: 'autogenerated', | ||
dirName: 'navigation', | ||
}], | ||
Entities: [ | ||
{ | ||
type: 'autogenerated', | ||
dirName: 'entities', | ||
} | ||
], | ||
Categories: [ | ||
"type": "autogenerated", | ||
"dirName": "user" | ||
}, | ||
{ | ||
type: 'autogenerated', | ||
dirName: 'categories', | ||
} | ||
], | ||
"Download": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "setup" | ||
} | ||
] | ||
}, | ||
{ | ||
"Configuration": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "configuration" | ||
} | ||
] | ||
}, | ||
{ | ||
"Categories": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "categories" | ||
} | ||
] | ||
}, | ||
{ | ||
"Usage": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "basic" | ||
} | ||
] | ||
}, | ||
{ | ||
"Entities": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "entities" | ||
} | ||
] | ||
}, | ||
{ | ||
"Navigation": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "navigation" | ||
} | ||
] | ||
}, | ||
"community_guides" | ||
] | ||
}, | ||
setup: { | ||
Setup: ['setup/prerequisites', 'setup/download'], | ||
Configuration: ['configuration/basic', 'configuration/options'], | ||
Remove: ['setup/remove'], | ||
"publisher": { | ||
"Publisher documentation": [ | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "publisher" | ||
}, | ||
{ | ||
"type": "autogenerated", | ||
"dirName": "publish" | ||
} | ||
] | ||
}, | ||
'developer documentation': { | ||
'HACS Development': [ | ||
"developer": { | ||
"Developer documentation": [ | ||
{ | ||
type: 'autogenerated', | ||
dirName: 'developer', | ||
"type": "autogenerated", | ||
"dirName": "developer" | ||
} | ||
], | ||
'Publish to HACS': [ | ||
'publish/start', | ||
'publish/appdaemon', | ||
'publish/integration', | ||
'publish/plugin', | ||
'publish/python_script', | ||
'publish/theme', | ||
'publish/include', | ||
'publish/action', | ||
'publish/remove', | ||
], | ||
] | ||
}, | ||
FAQ: [ | ||
"faq": { | ||
"FAQ": [ | ||
{ | ||
type: 'autogenerated', | ||
dirName: 'faq', | ||
}, | ||
], | ||
} | ||
"type": "autogenerated", | ||
"dirName": "faq" | ||
} | ||
] | ||
} | ||
} |
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