Skip to content

Commit

Permalink
first
Browse files Browse the repository at this point in the history
  • Loading branch information
ironicbadger committed Feb 6, 2020
0 parents commit 403cfc3
Show file tree
Hide file tree
Showing 10 changed files with 135 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# Created by https://www.gitignore.io/api/code
# Edit at https://www.gitignore.io/?templates=code

### Code ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# End of https://www.gitignore.io/api/code

site/
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# selfhostedshow/wiki

This repository contains the backend for the [Self-Hosted](https://selfhosted.show) podcast wiki.

## Usage

Add the following line to your mkdocs.yml:

theme:
name: 'material'

Mount the folder where your mkdocs.yml resides as a volume into /docs:

* Start development server on http://localhost:8000

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

* Build documentation

docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build

* Deploy documentation to GitHub Pages

docker run --rm -it -v ~/.ssh:/root/.ssh -v ${PWD}:/docs squidfunk/mkdocs-material gh-deploy

For detailed installation instructions and a demo, visit http://squidfunk.github.io/mkdocs-material/
10 changes: 10 additions & 0 deletions docs/basics/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Basics

Welcome to the Self Hosting basics section of the wiki. Here you will find a bunch of links and useful information for you to get started on your own Self-Hosting journey.

Things here might include:

* Where to start
* Hardware
* docker + docker-compose 101
* Links to docs.linuxserver.io
3 changes: 3 additions & 0 deletions docs/home-automation/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting Started with Home Automation

1. Install Home Assistant, profit.
3 changes: 3 additions & 0 deletions docs/home-automation/home-assistant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Home Assistant

It's awesome.
7 changes: 7 additions & 0 deletions docs/home-automation/tasmota.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Tasmota

Free your devices from the cloud.

## Useful Links

* [Template repository](https://templates.blakadder.com/index.html)
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to the Self Hosted wiki.

Here you will find an [open source](link), living and breathing repository of resources that we talk about on the Self Hosted podcast. You can help us help you by submitting PRs on Github to improve this documentation or fix mistakes.

## About the show

The show is your gateway to self hosting all the things.

Discover new software to take control of cloud services and own your data. Learn how you can take steps to free yourself from the agenda of large corporates and business models designed to sell your information. We help you unlock the power of Linux and Open Source.

## Our other podcasts

* [Linux Action News](https://linuxactionnews.com/) - A weekly Linux news and analysis podcast
* [Linux Unplugged](http://linuxunplugged.com/) - Your virtual Linux User Group
* [TechSNAP](https://techsnap.systems) - Your weekly Systems, Network and Administration Podcast
* [Coder Radio](https://coder.show/) - A weekly talk show taking a pragmatic look at the art and business of Software Development and related technologies
* [User Error](https://error.show/) - Life is a series of mistakes, but that's what makes it interesting
4 changes: 4 additions & 0 deletions docs/self-hosted-apps/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Getting Started

Be sure to check out [awesome-selfhosted](https://github.com/awesome-selfhosted/awesome-selfhosted#wikis) but here are our favourites along with code snippets for simple deployment.

11 changes: 11 additions & 0 deletions docs/self-hosted-apps/wikis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Self Hosted Wikis

As always, check out [awesome-selfhosted](https://github.com/awesome-selfhosted/awesome-selfhosted#wikis) but here are our favourites.

## Tiddlywiki

The interface is a little utilitarian but it suits scatter brains rather well.

## wiki.js

Beautiful but complex.
40 changes: 40 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
site_name: Self-Hosted Show Wiki
theme:
name: 'material'
palette:
primary: 'amber'
accent: 'orange'
text: 'Ubuntu'
code: 'Ubuntu Mono'
nav:
- Home: index.md
- Basics: basics/getting-started.md
- Home Automation: home-automation/getting-started.md
- Home Assistant: home-automation/home-assistant.md
- Tasmota: home-automation/tasmota.md
- Apps: self-hosted-apps/getting-started.md
- Wikis: self-hosted-apps/wikis.md
extra:
social:
- type: 'github'
link: 'https://github.com/selfhostedshow'
- type: 'twitter'
link: 'https://twitter.com/selfhostedshow'
- type: 'fire'
link: 'https://fireside.com'
- type: 'microphone'
link: 'https://pocketcasts.com'
- type: 'graduation-cap'
link: 'https://linuxacademy.com'
- type: 'linux'
link: 'https://jupiterbroadcasting.com'
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
- toc:
permalink: true
plugins:
- search
- minify:
minify_html: true

0 comments on commit 403cfc3

Please sign in to comment.