mirror of
https://github.com/hassio-addons/repository.git
synced 2025-05-06 12:11:29 +00:00
✨ Adds basic site
This commit is contained in:
parent
a712736cdb
commit
fb4a318b82
5 changed files with 109 additions and 0 deletions
9
.gitignore
vendored
9
.gitignore
vendored
|
@ -2,3 +2,12 @@ bin/*
|
|||
!bin/create_all.sh
|
||||
!bin/create_hassio_addon.sh
|
||||
!bin/travis_build.sh
|
||||
*.do
|
||||
bin/*
|
||||
docs/*
|
||||
site/*
|
||||
pip-selfcheck.json
|
||||
pyvenv.cfg
|
||||
include/
|
||||
lib/
|
||||
venv/
|
||||
|
|
27
build-site.sh
Executable file
27
build-site.sh
Executable file
|
@ -0,0 +1,27 @@
|
|||
#!/usr/bin/env bash
|
||||
# ==============================================================================
|
||||
# Community Hass.io Add-ons for Home Assistant
|
||||
# This script builds a small little website
|
||||
# ==============================================================================
|
||||
set -o errexit # Exit script when a command exits with non-zero status
|
||||
set -o errtrace # Exit on error inside any functions or sub-shells
|
||||
set -o nounset # Exit script on use of an undefined variable
|
||||
set -o pipefail # Return exit status of the last command in the pipe that failed
|
||||
|
||||
# Switch to the root of the repository.
|
||||
cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")"
|
||||
|
||||
# Create a documentation folder
|
||||
mkdir -p docs
|
||||
|
||||
# Install requirements
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Get the pages into the docs folder
|
||||
ln -sf ../README.md docs/index.md
|
||||
ln -sf ../LICENSE.md docs/license.md
|
||||
ln -sf ../CONTRIBUTING.md docs/contributing.md
|
||||
ln -sf ../CODE_OF_CONDUCT.md docs/code-of-conduct.md
|
||||
|
||||
# Build!
|
||||
mkdocs build
|
68
mkdocs.yml
Normal file
68
mkdocs.yml
Normal file
|
@ -0,0 +1,68 @@
|
|||
# Project information
|
||||
site_name: 'Community Hass.io Add-ons for Home Assistant'
|
||||
site_url: 'https://addons.community'
|
||||
site_description: 'The primary goal of this project is to provide you (as a Hass.io / Home Assistant user) with additional, high quality, add-ons that allow you to take your automated home to the next level.'
|
||||
site_author: 'Franck Nijhof'
|
||||
copyright: 'Copyright 2017-2019 - Franck Nijhof.'
|
||||
|
||||
# Repository
|
||||
repo_name: 'hassio-addons'
|
||||
repo_url: 'https://github.com/hassio-addons/repository'
|
||||
edit_uri: ''
|
||||
|
||||
# Theme configuration
|
||||
theme:
|
||||
name: 'material'
|
||||
logo: 'https://avatars3.githubusercontent.com/u/30772201?s=200&v=4'
|
||||
icon: 'https://avatars3.githubusercontent.com/u/30772201?s=200&v=4'
|
||||
language: 'en'
|
||||
palette:
|
||||
primary: 'light-blue'
|
||||
accent: 'blue'
|
||||
font:
|
||||
text: 'Exo2'
|
||||
code: 'Roboto Mono'
|
||||
feature:
|
||||
tabs: false
|
||||
extra_css:
|
||||
- css/extra.css
|
||||
|
||||
# Customization
|
||||
extra:
|
||||
manifest: 'manifest.webmanifest'
|
||||
social:
|
||||
- type: 'github'
|
||||
link: 'https://github.com/hassio-addons'
|
||||
- type: 'twitter'
|
||||
link: 'https://twitter.com/hassio-addons'
|
||||
- type: 'twitch'
|
||||
link: 'https://twitch.tv/frenck'
|
||||
- type: 'youtube'
|
||||
link: 'https://youtube.com/frenck'
|
||||
|
||||
# Extensions
|
||||
markdown_extensions:
|
||||
- toc:
|
||||
permalink: true
|
||||
- pymdownx.betterem:
|
||||
smart_enable: all
|
||||
- pymdownx.caret
|
||||
- pymdownx.critic
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_generator: !!python/name:pymdownx.emoji.to_svg
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.mark
|
||||
- pymdownx.smartsymbols
|
||||
- pymdownx.superfences
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- pymdownx.tilde
|
||||
|
||||
# The pages to serve
|
||||
pages:
|
||||
- "Our Add-ons": "index.md"
|
||||
- "Contributing": "contributing.md"
|
||||
- "Code of Conduct": "code-of-conduct.md"
|
||||
- "License": "license.md"
|
3
netlify.toml
Normal file
3
netlify.toml
Normal file
|
@ -0,0 +1,3 @@
|
|||
[build]
|
||||
publish = "site"
|
||||
command = "./scripts/build.sh"
|
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
@ -0,0 +1,2 @@
|
|||
mkdocs==1.0.4
|
||||
mkdocs-material==4.4.0
|
Loading…
Add table
Add a link
Reference in a new issue