From 7448a02c714ce33443370af5893abeac025b8129 Mon Sep 17 00:00:00 2001 From: Aleksandar Trifunovic <akstrfn@gmail.com> Date: Mon, 10 Dec 2018 10:49:08 +0100 Subject: [PATCH] Add table of contents (#15) --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 588c238..a4102d7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,30 @@ As an application wiki, XWiki allows for the storing of structured data and the  +# Table of contents +<!-- generated with pandoc -f gfm --toc -o readme-toc.md README.md --> + +- [Introduction](#introduction) +- [How to use this image](#how-to-use-this-image) + - [Pulling existing image](#pulling-existing-image) + - [Using docker run](#using-docker-run) + - [Using docker-compose](#using-docker-compose) + - [Using Docker Swarm](#using-docker-swarm) + - [Using an external Solr service](#using-an-external-solr-service) + - [Preparing Solr container](#preparing-solr-container) + - [Docker run example](#docker-run-example) + - [Docker Compose example](#docker-compose-example) + - [Building](#building) +- [Upgrading XWiki](#upgrading-xwiki) +- [Details for the xwiki image](#details-for-the-xwiki-image) + - [Configuration Options](#configuration-options) + - [Passing JVM options](#passing-jvm-options) + - [Miscellaneous](#miscellaneous) +- [License](#license) +- [Support](#support) +- [Contribute](#contribute) +- [Credits](#credits) + # Introduction The goal is to provide a production-ready XWiki system running in Docker. This is why: -- GitLab