From 717894d8c53c0f55ab7e70e9dea6002751c1605d Mon Sep 17 00:00:00 2001 From: Evan Steinkerchner Date: Sun, 20 Mar 2022 20:19:49 -0400 Subject: Initial draft of new docs UI usuing MkDocs --- .gitignore | 8 ++- docs/images/logo.png | Bin 0 -> 37168 bytes docs/images/screenshot.png | Bin 0 -> 50927 bytes docs/index.md | 122 ++++++++++++++++++++++++++++++++++++++++++++ docs/screenshot.png | Bin 50927 -> 0 bytes docs/stylesheets/styles.css | 7 +++ mkdocs.yml | 81 +++++++++++++++++++++++++++++ 7 files changed, 217 insertions(+), 1 deletion(-) create mode 100644 docs/images/logo.png create mode 100644 docs/images/screenshot.png create mode 100644 docs/index.md delete mode 100644 docs/screenshot.png create mode 100644 docs/stylesheets/styles.css create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index ee51c88..d2cfd08 100644 --- a/.gitignore +++ b/.gitignore @@ -23,4 +23,10 @@ yarn-error.log* # App configuration config.yml -.drone.yml \ No newline at end of file +.drone.yml + +# Python venv +venv + +# MkDocs +site diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000..e088a4a Binary files /dev/null and b/docs/images/logo.png differ diff --git a/docs/images/screenshot.png b/docs/images/screenshot.png new file mode 100644 index 0000000..ffa7e79 Binary files /dev/null and b/docs/images/screenshot.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..36965ca --- /dev/null +++ b/docs/index.md @@ -0,0 +1,122 @@ +
+ Homer's donut +

Homer

+
+ +

+ A dead simple static HOMepage for your servER to keep + your services on hand, from a simple yaml configuration file. +

+ +
+ + License: Apache 2 + + + Gitter chat + + + Download homer static build + + + Awesome + +
+ +## Demo + +[![Demo](images/screenshot.png)](https://homer-demo.netlify.app) +[Check out the demo!](https://homer-demo.netlify.app) + +## Features + +- [yaml](http://yaml.org/) file configuration +- Installable (pwa) +- Search +- Grouping +- Theme customization +- Offline health check +- keyboard shortcuts: + - `/` Start searching. + - `Escape` Stop searching. + - `Enter` Open the first matching result (respects the bookmark's `_target` property). + - `Alt`/`Option` + `Enter` Open the first matching result in a new tab. + +## Getting started + +Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**. + +See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. + +### Using docker + +To launch container: + +```sh +docker run -d \ + -p 8080:8080 \ + -v :/www/assets \ + --restart=always \ + b4bz/homer:latest +``` + +Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`). + +### Using docker-compose + +The `docker-compose.yml` file must be edited to match your needs. +Set the port and volume (equivalent to `-p` and `-v` arguments): + +```yaml +volumes: + - /your/local/assets/:/www/assets +ports: + - 8080:8080 +``` + +To launch container: + +```sh +cd /path/to/docker-compose.yml +docker-compose up -d +``` + +Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`: + +```yaml +environment: + - UID=1000 + - GID=1000 +``` + +### Using the release tarball (prebuilt, ready to use) + +Download and extract the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a web server. + +```sh +wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip +unzip homer.zip +cd homer +cp assets/config.yml.dist assets/config.yml +npx serve # or python -m http.server 8010 or apache, nginx ... +``` + +### Build manually + +```sh +# Using yarn (recommended) +yarn install +yarn build + +# **OR** Using npm +npm install +npm run build +``` + +Then your dashboard is ready to use in the `/dist` directory. diff --git a/docs/screenshot.png b/docs/screenshot.png deleted file mode 100644 index ffa7e79..0000000 Binary files a/docs/screenshot.png and /dev/null differ diff --git a/docs/stylesheets/styles.css b/docs/stylesheets/styles.css new file mode 100644 index 0000000..e1e1a3e --- /dev/null +++ b/docs/stylesheets/styles.css @@ -0,0 +1,7 @@ +.centered { + text-align: center; +} + +.bold { + font-weight: bold; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..58e37c3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,81 @@ +# Project information +site_name: Homer +site_url: https://bastienwirtz.github.io/homer/ + +# Repository +repo_name: bastienwirtz/homer +repo_url: https://github.com/bastienwirtz/homer +edit_uri: "" + +# Stylesheet +extra_css: + - stylesheets/styles.css + +# Theme +theme: + logo: images/logo.png + name: material + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue + accent: blue + toggle: + icon: material/brightness-4 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: blue + accent: blue + toggle: + icon: material/brightness-7 + name: Switch to light mode + features: + - content.code.annotate + - navigation.indexes + - navigation.sections + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + +# Copyright - name for footer text +copyright: Homer dashboard + +# Socials +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/bastienwirtz/homer + - icon: fontawesome/brands/gitter + link: https://gitter.im/homer-dashboard/community + - icon: fontawesome/brands/docker + link: https://hub.docker.com/r/b4bz/homer + +# Extensions +markdown_extensions: + - abbr + - admonition + - attr_list + - def_list + - footnotes + - meta + - md_in_html + - toc: + permalink: true + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + +# Page tree +nav: + - Home: index.md + - Configuration: configuration.md + - Custom services: customservices.md + - Tips & tricks: tips-and-tricks.md + - Development: development.md + - Troubleshooting: troubleshooting.md -- cgit v1.2.3