-
-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic documentation website + deployment (#235)
- Loading branch information
Showing
11 changed files
with
140 additions
and
0 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,46 @@ | ||
--- | ||
name: Documentation | ||
|
||
on: | ||
push: | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build: | ||
name: Build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: ⤵️ Check out code from GitHub | ||
uses: actions/[email protected] | ||
|
||
- name: 🏗 Set up Node.js | ||
uses: actions/[email protected] | ||
with: | ||
node-version-file: "documentation/.nvmrc" | ||
|
||
- name: 🏗 Install MyST | ||
run: npm install -g myst-cli | ||
|
||
- name: 🚀 Build documenation | ||
working-directory: ./documentation | ||
run: myst build --html | ||
|
||
- name: 🆙 Upload artifact | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
path: ./documentation/_build/html | ||
|
||
deploy: | ||
name: Deploy | ||
runs-on: ubuntu-latest | ||
needs: build | ||
if: github.ref == 'refs/heads/main' | ||
permissions: | ||
pages: write | ||
id-token: write | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
uses: actions/[email protected] |
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 |
---|---|---|
|
@@ -120,3 +120,7 @@ node_modules/ | |
|
||
# Deepcode AI | ||
.dccache | ||
|
||
# Mystjs | ||
.ipynb_checkpoints | ||
_build |
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 @@ | ||
18 |
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,6 @@ | ||
format: jb-book | ||
root: index | ||
parts: | ||
- caption: Reference | ||
chapters: | ||
- file: glossary |
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,16 @@ | ||
--- | ||
title: Glossary | ||
subject: Reference | ||
description: Glossary of terms used by Spook. | ||
exports: | ||
- format: pdf | ||
--- | ||
|
||
:::{glossary} | ||
|
||
[HACS](https://hacs.xyz/) | ||
: Home Assistant Community Store. A third-party integrations store for Home Assistant. It provides custom integrations for Home Assistant that are not available in a standard Home Assistant installation. These integrations are not supported by the Home Assistant project. | ||
: As the Spook integration does unsupported things, it is only available through HACS. | ||
: <https://hacs.xyz> | ||
|
||
::: |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,27 @@ | ||
--- | ||
title: Spook 👻 Not your homie. | ||
--- | ||
|
||
```{image} ./images/logo.png | ||
:alt: The Spook logo | ||
:align: center | ||
``` | ||
|
||
_Spook is a scary powerfull toolbox for Home Assistant, but be aware, Spook is not your homie!_ | ||
|
||
:::{important} | ||
The Spook documentation is currently in development. | ||
|
||
**It is not complete and may contain errors** | ||
(but honestly, that will also be the case when it is complete). | ||
::: | ||
|
||
So, there a lot of things/features, that will never end up in Home Assistant itself. | ||
|
||
This can have various reasons, for example: It is just too random, out of scope, not matching the Home Assistant philosophy, iolating architectural design, still in early development, experimental, explorative, or just freaking useless. | ||
|
||
Spook doesn't care. He is nobodies homie. | ||
|
||
So, maybe, that one feature you wanted Home Assistant to have, is in Spook. | ||
|
||
However, remember, Spook is not your homie. All stuff in here, is not part of Home Assistant (or at least not yet) for a reason. So, don't expect it to work, or to be supported, or well, for starters, to be a good idea. |
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,40 @@ | ||
# See docs at: https://mystmd.org/guide/frontmatter | ||
version: 1 | ||
site: | ||
template: book-theme | ||
logo_text: "A scary powerfull toolbox for Home Assistant." | ||
logo: ./images/logo.png | ||
logo_dark: ./images/logo_dark.png | ||
twitter: frenck | ||
license: | ||
content: MIT | ||
code: "Passive Aggressive License" | ||
nav: [] | ||
actions: | ||
- title: "👻 Install via HACS 🏡" | ||
url: https://my.home-assistant.io/redirect/hacs_repository/?owner=frenck&repository=spook&category=integrations | ||
- title: 💬 Support | ||
url: https://github.com/frenck/spook/discussions | ||
domains: [] | ||
|
||
project: | ||
title: Spook 👻 Not your homie. | ||
description: "👻 Spook is a scary powerfull toolbox for Home Assistant." | ||
thumbnail: ./images/social.png | ||
keywords: | ||
- spook | ||
- "Home Assistant" | ||
- "Home Assistant Community Store" | ||
- "Home Assistant Community" | ||
- "hass" | ||
- "hacs" | ||
- "custom integration" | ||
- "powertools" | ||
- "iot" | ||
- "internet of things" | ||
- "home automation" | ||
- "smart home" | ||
github: https://github.com/frenck/spook | ||
abbreviations: | ||
HACS: Home Assistant Community Store | ||
HA: Home Assistant |
Binary file not shown.