Skip to content

Commit 6f234af

Browse files
committed
Build docs
1 parent eb0bd43 commit 6f234af

7 files changed

+80
-1
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,6 @@
22

33
node_modules
44
package-lock.json
5+
6+
site
7+
docs

LICENSE.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[https://creativecommons.org/publicdomain/zero/1.0/](https://creativecommons.org/publicdomain/zero/1.0/)

_config.yml

-1
This file was deleted.

mkdocs.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
site_name: "Awesome Raspberry Pi"
2+
site_url: "https://awesome-rpi.netlify.com"
3+
site_description: "A curated list of awesome Raspberry Pi resources"
4+
site_author: "Thibault Maekelbergh"
5+
copyright: "Copyright 2016 - Thibault Maekelbergh. Creative Commons Attribution 4.0."
6+
7+
# Repository
8+
repo_name: "awesome-raspberry-pi"
9+
repo_url: "https://github.com/thibmaek/awesome-raspberry-pi"
10+
edit_uri: ""
11+
12+
# Theme configuration
13+
theme:
14+
name: "material"
15+
logo: "https://www.raspberrypi.org/wp-content/uploads/2012/03/raspberry-pi-logo.png"
16+
icon: "https://www.raspberrypi.org/wp-content/uploads/2012/03/raspberry-pi-logo.png"
17+
language: "en"
18+
palette:
19+
primary: "#e30b5d"
20+
feature:
21+
tabs: false
22+
extra_css:
23+
- css/extra.css
24+
25+
# Extensions
26+
markdown_extensions:
27+
- toc:
28+
permalink: true
29+
- pymdownx.betterem:
30+
smart_enable: all
31+
- pymdownx.caret
32+
- pymdownx.critic
33+
- pymdownx.details
34+
- pymdownx.emoji:
35+
emoji_generator: !!python/name:pymdownx.emoji.to_svg
36+
- pymdownx.inlinehilite
37+
- pymdownx.magiclink
38+
- pymdownx.mark
39+
- pymdownx.smartsymbols
40+
- pymdownx.superfences
41+
- pymdownx.tasklist:
42+
custom_checkbox: true
43+
- pymdownx.tilde
44+
- mdx_truly_sane_lists
45+
46+
# The pages to serve
47+
nav:
48+
- "Home": "index.md"
49+
- "Contributing": "contributing.md"

netlify.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build]
2+
publish = "site"
3+
command = "./scripts/build.sh"

requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs==1.0.4
2+
mkdocs-material==4.4.3
3+
mdx_truly_sane_lists==1.2

scripts/build-docs.sh

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/usr/bin/env bash
2+
# Ref: https://github.com/frenck/awesome-home-assistant/blob/master/scripts/build.sh
3+
4+
set -o errexit # Exit script when a command exits with non-zero status
5+
set -o errtrace # Exit on error inside any functions or sub-shells
6+
set -o nounset # Exit script on use of an undefined variable
7+
set -o pipefail # Return exit status of the last command in the pipe that failed
8+
9+
# Switch to the root of the repository.
10+
cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")"
11+
12+
# Install requirements
13+
pip install -r requirements.txt
14+
15+
# Get the pages into the docs folder
16+
ln -sf ../README.md docs/index.md
17+
ln -sf ../LICENSE.md docs/license.md
18+
ln -sf ../CONTRIBUTING.md docs/contributing.md
19+
20+
# Build!
21+
mkdocs build

0 commit comments

Comments
 (0)