From caab2d2cdb29dfffc97ff03adf1a8d96deea29fa Mon Sep 17 00:00:00 2001 From: Alexis Couvreur Date: Fri, 11 Nov 2022 19:01:57 +0000 Subject: [PATCH] docs: remove emoji markdown links are broken --- README.md | 16 ++++++++-------- plugins/traefik/README.md | 12 ++++++------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 99afd0c..9bfba33 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ⏳ Sablier +# Sablier ![Github Actions](https://img.shields.io/github/workflow/status/acouvreur/sablier/Build?style=flat-square) ![Go Report](https://goreportcard.com/badge/github.com/acouvreur/sablier?style=flat-square) ![Go Version](https://img.shields.io/github/go-mod/go-version/acouvreur/sablier?style=flat-square) ![Latest Release](https://img.shields.io/github/release/acouvreur/sablier/all.svg?style=flat-square) @@ -10,9 +10,9 @@ Which allows you to start your containers on demand and shut them down automatic ![Hourglass](https://raw.githubusercontent.com/acouvreur/sablier/main/docs/img/hourglass.png) -- [⏳ Sablier](#-sablier) - - [⚡️ Quick start](#️-quick-start) - - [⚙️ Configuration](#️-configuration) +- [Sablier](#sablier) + - [Quick start](#quick-start) + - [Configuration](#configuration) - [Configuration File](#configuration-file) - [Environment Variables](#environment-variables) - [Arguments](#arguments) @@ -24,13 +24,13 @@ Which allows you to start your containers on demand and shut them down automatic - [Dynamic Strategy Configuration](#dynamic-strategy-configuration) - [Creating your own loading theme](#creating-your-own-loading-theme) - [Blocking the loading until the session is ready](#blocking-the-loading-until-the-session-is-ready) - - [💾 Saving the state to a file](#-saving-the-state-to-a-file) + - [Saving the state to a file](#saving-the-state-to-a-file) - [Reverse proxies integration plugins](#reverse-proxies-integration-plugins) - [Traefik Middleware Plugin](#traefik-middleware-plugin) - [Glossary](#glossary) - [Credits](#credits) -## ⚡️ Quick start +## Quick start ```bash # Create and stop nginx container @@ -71,7 +71,7 @@ curl 'http://localhost:10000/api/strategies/blocking?names=nginx&names=whoami&se } ``` -## ⚙️ Configuration +## Configuration There are three different ways to define configuration options in Sablier: @@ -256,7 +256,7 @@ strategy: default-timeout: 1m ``` -## 💾 Saving the state to a file +## Saving the state to a file You can save the state of the application in case of failure to resume your sessions. diff --git a/plugins/traefik/README.md b/plugins/traefik/README.md index 59685f6..7414472 100644 --- a/plugins/traefik/README.md +++ b/plugins/traefik/README.md @@ -2,9 +2,9 @@ - [Traefik Sablier Plugin](#traefik-sablier-plugin) - [Installation](#installation) - - [🐳 Traefik with Docker classic](#-traefik-with-docker-classic) - - [🐙 Traefik with Docker Swarm](#-traefik-with-docker-swarm) - - [☸️ Traefik with Kubernetes](#️-traefik-with-kubernetes) + - [Traefik with Docker classic](#traefik-with-docker-classic) + - [Traefik with Docker Swarm](#traefik-with-docker-swarm) + - [Traefik with Kubernetes](#traefik-with-kubernetes) - [Plugin](#plugin) - [Development](#development) @@ -48,7 +48,7 @@ http: You can also checkout the End to End tests here: [e2e](./e2e/). -## 🐳 Traefik with Docker classic +## Traefik with Docker classic **Container labels cannot be used** @@ -121,7 +121,7 @@ http: service: "whoami" ``` -## 🐙 Traefik with Docker Swarm +## Traefik with Docker Swarm ⚠️ Limitations @@ -137,7 +137,7 @@ http: ``` - We cannot use [allowEmptyServices](https://doc.traefik.io/traefik/providers/docker/#allowemptyservices) because if you use the [blocking strategy](LINKHERE) you will receive a `503`. -## ☸️ Traefik with Kubernetes +## Traefik with Kubernetes - The format of the `names` section is `___` where `_` is the delimiter. - Thus no `_` are allowed in ``