diff --git a/README.md b/README.md index f432ada..3469de9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ -# Open-Mate +[![Website](https://img.shields.io/website?url=https%3A%2F%2Fhomate.club)](https://homate.club/) + +# Open-Mate [![Mastodon Follow](https://img.shields.io/mastodon/follow/115457697026812609?style=social)](https://mastodon.social/@homate) + The best mate-lemonade on campus! diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..6f7f3d5 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +homate.club \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..d0914cc --- /dev/null +++ b/docs/README.md @@ -0,0 +1,17 @@ + + +# Hey 👋 + +Welcome to the official "HOMatE.club" documentation: A local implementation of [Open-Mate](https://github.com/leandroebner/Open-Mate/), an open source mate-lemonade recipe, providing a DIY alternative to commercially available mate-drinks. + +## About + +HOMatE.club is an attempt and project to create, test, share and iterate an open source recipe for mate-flavoured beverages like the well-known mate-lemonade. The drink is available to the public at our local makerspace "[House Of Makers and Engineers](https://home.rwu.de)". + +## Status + +Check the current stock of HOMatE.club at our makerspace [here](status). This page displays helpful information on whether you can stop by to enjoy a drink and helps you estimate when the next batch of drinks will be finished. All changes are tracked in a local Git repository and are visible in the appended history. + +## Roadmap + +While the growing quantities of caffeine help me to stay productive, this project is still an early stage of work in progress and subject to major changes and updates. diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..243ffbd --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,5 @@ +theme: jekyll-theme-minimal +logo: /assets/logo.svg +title: HOMatE.club +description: The best mate-lemonade on campus! +show_downloads: false diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 0000000..bf863bd --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,56 @@ + + + + + + + +{% seo %} + + + {% include head-custom.html %} + + +
+
+

{{ site.title | default: site.github.repository_name }}

+ + {% if site.logo %} + Logo + {% endif %} + +

{{ site.description | default: site.github.project_tagline }}

+ + {% if site.github.is_project_page %} +

View the Project on GitHub {{ site.github.repository_nwo }}

+ {% endif %} + + {% if site.github.is_user_page %} +

View My GitHub Profile

+ {% endif %} + + {% if site.show_downloads %} + + {% endif %} +
+
+ + {{ content }} + +
+ +
+ + + diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss new file mode 100644 index 0000000..6bf9993 --- /dev/null +++ b/docs/assets/css/style.scss @@ -0,0 +1,8 @@ +--- +--- + +@import "jekyll-theme-minimal"; + +.gist .gist-meta { + display: none; +} diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..138760a --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,325 @@ + + + + diff --git a/docs/status/README.md b/docs/status/README.md new file mode 100644 index 0000000..21b2a1d --- /dev/null +++ b/docs/status/README.md @@ -0,0 +1,5 @@ + + +# Status + +{% gist 334a2b820d256ba60b36c6761d803661 %} diff --git a/docs/status/syntax.md b/docs/status/syntax.md new file mode 100644 index 0000000..84681e8 --- /dev/null +++ b/docs/status/syntax.md @@ -0,0 +1,17 @@ + + +Syntax Version 1.0.0 + +``` +##
$ +DD.MM.YYYY HHhMMm | + +
+ +## History + +
+ +> ####
$ +> DD.MM.YYYY HHhMMm | +```