testing around with github pages

This commit is contained in:
vabene1111 2021-01-03 09:47:57 +01:00
parent 279b4dc025
commit e8b9f473a6
27 changed files with 72 additions and 5 deletions

View File

@ -42,7 +42,7 @@ The docker image (`vabene1111/recipes`) simply exposes the application on port `
### Docker-Compose [Recommended]
1. Choose one of the included configurations [here](docs/docker).
1. Choose one of the included configurations [here](docs/install/docker).
2. Download the environment (config) file template and fill it out `wget https://raw.githubusercontent.com/vabene1111/recipes/develop/.env.template -O .env`
3. Start the container `docker-compose up -d`
4. Open the page to create the first user.
@ -50,11 +50,11 @@ The docker image (`vabene1111/recipes`) simply exposes the application on port `
### Manual
**Python >= 3.8** is required to run this!
Refer to [manual install](docs/manual_install) for detailed instructions.
Refer to [manual install](docs/install/manual_install) for detailed instructions.
### Kubernetes
You can find a basic kubernetes setup [here](docs/k8s/). Please see the README in the folder for more detail.
You can find a basic kubernetes setup [here](docs/install/k8s/). Please see the README in the folder for more detail.
## Updating

12
docs/_data/navigation.yml Normal file
View File

@ -0,0 +1,12 @@
- title: Home
url: /
- title: Group of Things
url: /group/
sublinks:
- title: Sub-item 1
url: /group/si1
- title: Sub-item 2
url: /group/si2
- title: Sub-item 3
url: /group/si3

View File

@ -0,0 +1,37 @@
{% for entry in site.data.navigation %}
{% capture fullurl %}{{ site.baseurl }}{{ entry.url }}{% endcapture %}
{% if fullurl == page.url %}
{% assign current_page = fullurl %}
{% break %}
{% elsif page.url contains fullurl %}
{% assign current_page = fullurl %}
{% endif %}
{% endfor %}
<!-- Then we build the nav bar. -->
<nav>
<ul>
{% for entry in site.data.navigation %}
{% if entry.url == current_page %}
<!-- uses yellow, you can change to any other hexadecimal colour code. -->
{% assign current = ' style="background-color: #FFFFFF"' %}
{% else %}
<!-- We have to declare it 'null' to ensure it doesn't propagate. -->
{% assign current = null %}
{% endif %}
{% assign sublinks = entry.sublinks %}
{% if sublinks %}
<li{{ current }}>
<a href="{{ site.baseurl }}{{ entry.url }}">{{ entry.title }}</a>
<ul>
{% for sublink in sublinks %}
<li><a href="{{ site.baseurl }}{{ sublink.url }}">{{ sublink.title }}</a></li>
{% endfor %}
</ul>
</li>
{% else %}
<li{{ current }}><a href="{{ site.baseurl }}{{ entry.url }}">{{ entry.title }}</a></li>
{% endif %}
{% endfor %}
</ul>
</nav>

View File

@ -1,3 +1,21 @@
## Welcome to GitHub Pages
# Welcome to Recipes
Test Edit
The recipe manager that allows you to manage your ever growing collection of digital recipes.
## Features
- :package: **Sync** files with Dropbox and Nextcloud (more can easily be added)
- :mag: Powerful **search** with Djangos [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity)
- :label: Create and search for **tags**, assign them in batch to all files matching certain filters
- :page_facing_up: **Create recipes** locally within a nice, standardized web interface
- :arrow_down: **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe)
- :iphone: Optimized for use on **mobile** devices like phones and tablets
- :shopping_cart: Generate **shopping** lists from recipes
- :calendar: Create a **Plan** on what to eat when
- :family: **Share** recipes with friends and comment on them to suggest or remember changes you made
- :heavy_division_sign: automatically convert decimal units to **fractions** for those who like this
- :whale: Easy setup with **Docker**
- :art: Customize your interface with **themes**
- :envelope: Export and import recipes from other users
- :earth_africa: localized in many languages thanks to the awesome community
- :heavy_plus_sign: Many more like recipe scaling, image compression, cookbooks, printing views, ...