Build docs

pull/149/head
Thibault Maekelbergh 2019-10-09 23:15:32 +02:00
parent eb0bd4335e
commit 6f234aff08
7 changed files with 80 additions and 1 deletions

3
.gitignore vendored
View File

@ -2,3 +2,6 @@
node_modules
package-lock.json
site
docs

1
LICENSE.md Normal file
View File

@ -0,0 +1 @@
[https://creativecommons.org/publicdomain/zero/1.0/](https://creativecommons.org/publicdomain/zero/1.0/)

View File

@ -1 +0,0 @@
theme: jekyll-theme-cayman

49
mkdocs.yml Normal file
View File

@ -0,0 +1,49 @@
site_name: "Awesome Raspberry Pi"
site_url: "https://awesome-rpi.netlify.com"
site_description: "A curated list of awesome Raspberry Pi resources"
site_author: "Thibault Maekelbergh"
copyright: "Copyright 2016 - Thibault Maekelbergh. Creative Commons Attribution 4.0."
# Repository
repo_name: "awesome-raspberry-pi"
repo_url: "https://github.com/thibmaek/awesome-raspberry-pi"
edit_uri: ""
# Theme configuration
theme:
name: "material"
logo: "https://www.raspberrypi.org/wp-content/uploads/2012/03/raspberry-pi-logo.png"
icon: "https://www.raspberrypi.org/wp-content/uploads/2012/03/raspberry-pi-logo.png"
language: "en"
palette:
primary: "#e30b5d"
feature:
tabs: false
extra_css:
- css/extra.css
# 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
- mdx_truly_sane_lists
# The pages to serve
nav:
- "Home": "index.md"
- "Contributing": "contributing.md"

3
netlify.toml Normal file
View File

@ -0,0 +1,3 @@
[build]
publish = "site"
command = "./scripts/build.sh"

3
requirements.txt Normal file
View File

@ -0,0 +1,3 @@
mkdocs==1.0.4
mkdocs-material==4.4.3
mdx_truly_sane_lists==1.2

21
scripts/build-docs.sh Executable file
View File

@ -0,0 +1,21 @@
#!/usr/bin/env bash
# Ref: https://github.com/frenck/awesome-home-assistant/blob/master/scripts/build.sh
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]}")")"
# 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
# Build!
mkdocs build