diff --git a/README.md b/README.md index 3915700e9..b7159d5da 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml new file mode 100644 index 000000000..0a25b62f2 --- /dev/null +++ b/docs/_data/navigation.yml @@ -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 \ No newline at end of file diff --git a/docs/_includes/navigation.html b/docs/_includes/navigation.html new file mode 100644 index 000000000..07a07ef42 --- /dev/null +++ b/docs/_includes/navigation.html @@ -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 %} + + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index bde8f57d3..7aaf3bab4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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, ... diff --git a/docs/docker/README.md b/docs/install/docker/README.md similarity index 100% rename from docs/docker/README.md rename to docs/install/docker/README.md diff --git a/docs/docker/nginx-proxy with proxy authentication/README.md b/docs/install/docker/nginx-proxy with proxy authentication/README.md similarity index 100% rename from docs/docker/nginx-proxy with proxy authentication/README.md rename to docs/install/docker/nginx-proxy with proxy authentication/README.md diff --git a/docs/docker/nginx-proxy with proxy authentication/docker-compose.yml b/docs/install/docker/nginx-proxy with proxy authentication/docker-compose.yml similarity index 100% rename from docs/docker/nginx-proxy with proxy authentication/docker-compose.yml rename to docs/install/docker/nginx-proxy with proxy authentication/docker-compose.yml diff --git a/docs/docker/nginx-proxy with proxy authentication/nginx/conf.d/Recipes.conf b/docs/install/docker/nginx-proxy with proxy authentication/nginx/conf.d/Recipes.conf similarity index 100% rename from docs/docker/nginx-proxy with proxy authentication/nginx/conf.d/Recipes.conf rename to docs/install/docker/nginx-proxy with proxy authentication/nginx/conf.d/Recipes.conf diff --git a/docs/docker/nginx-proxy/README.md b/docs/install/docker/nginx-proxy/README.md similarity index 100% rename from docs/docker/nginx-proxy/README.md rename to docs/install/docker/nginx-proxy/README.md diff --git a/docs/docker/nginx-proxy/docker-compose.yml b/docs/install/docker/nginx-proxy/docker-compose.yml similarity index 100% rename from docs/docker/nginx-proxy/docker-compose.yml rename to docs/install/docker/nginx-proxy/docker-compose.yml diff --git a/docs/docker/nginx-proxy/nginx/conf.d/Recipes.conf b/docs/install/docker/nginx-proxy/nginx/conf.d/Recipes.conf similarity index 100% rename from docs/docker/nginx-proxy/nginx/conf.d/Recipes.conf rename to docs/install/docker/nginx-proxy/nginx/conf.d/Recipes.conf diff --git a/docs/docker/plain/README.md b/docs/install/docker/plain/README.md similarity index 100% rename from docs/docker/plain/README.md rename to docs/install/docker/plain/README.md diff --git a/docs/docker/plain/docker-compose.yml b/docs/install/docker/plain/docker-compose.yml similarity index 100% rename from docs/docker/plain/docker-compose.yml rename to docs/install/docker/plain/docker-compose.yml diff --git a/docs/docker/plain/nginx/conf.d/Recipes.conf b/docs/install/docker/plain/nginx/conf.d/Recipes.conf similarity index 100% rename from docs/docker/plain/nginx/conf.d/Recipes.conf rename to docs/install/docker/plain/nginx/conf.d/Recipes.conf diff --git a/docs/docker/synology/README.md b/docs/install/docker/synology/README.md similarity index 100% rename from docs/docker/synology/README.md rename to docs/install/docker/synology/README.md diff --git a/docs/docker/traefik-nginx/README.md b/docs/install/docker/traefik-nginx/README.md similarity index 100% rename from docs/docker/traefik-nginx/README.md rename to docs/install/docker/traefik-nginx/README.md diff --git a/docs/docker/traefik-nginx/docker-compose.yml b/docs/install/docker/traefik-nginx/docker-compose.yml similarity index 100% rename from docs/docker/traefik-nginx/docker-compose.yml rename to docs/install/docker/traefik-nginx/docker-compose.yml diff --git a/docs/docker/traefik-nginx/nginx/conf.d/Recipes.conf b/docs/install/docker/traefik-nginx/nginx/conf.d/Recipes.conf similarity index 100% rename from docs/docker/traefik-nginx/nginx/conf.d/Recipes.conf rename to docs/install/docker/traefik-nginx/nginx/conf.d/Recipes.conf diff --git a/docs/docker/traefik/README.md b/docs/install/docker/traefik/README.md similarity index 100% rename from docs/docker/traefik/README.md rename to docs/install/docker/traefik/README.md diff --git a/docs/docker/traefik/docker-compose.yml b/docs/install/docker/traefik/docker-compose.yml similarity index 100% rename from docs/docker/traefik/docker-compose.yml rename to docs/install/docker/traefik/docker-compose.yml diff --git a/docs/k8s/10-configmap.yaml b/docs/install/k8s/10-configmap.yaml similarity index 100% rename from docs/k8s/10-configmap.yaml rename to docs/install/k8s/10-configmap.yaml diff --git a/docs/k8s/30-pv.yaml b/docs/install/k8s/30-pv.yaml similarity index 100% rename from docs/k8s/30-pv.yaml rename to docs/install/k8s/30-pv.yaml diff --git a/docs/k8s/30-pvc.yaml b/docs/install/k8s/30-pvc.yaml similarity index 100% rename from docs/k8s/30-pvc.yaml rename to docs/install/k8s/30-pvc.yaml diff --git a/docs/k8s/50-deployment.yaml b/docs/install/k8s/50-deployment.yaml similarity index 100% rename from docs/k8s/50-deployment.yaml rename to docs/install/k8s/50-deployment.yaml diff --git a/docs/k8s/60-service.yaml b/docs/install/k8s/60-service.yaml similarity index 100% rename from docs/k8s/60-service.yaml rename to docs/install/k8s/60-service.yaml diff --git a/docs/k8s/README.md b/docs/install/k8s/README.md similarity index 100% rename from docs/k8s/README.md rename to docs/install/k8s/README.md diff --git a/docs/manual_install/Readme.md b/docs/install/manual_install/Readme.md similarity index 100% rename from docs/manual_install/Readme.md rename to docs/install/manual_install/Readme.md