From 743ca9cb55192cdd7e36b68f2c5b4a4d5c18d63b Mon Sep 17 00:00:00 2001 From: Felix Hennig Date: Mon, 12 Sep 2022 16:35:21 +0200 Subject: [PATCH] Documented tracking in the readme --- README.adoc | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.adoc b/README.adoc index f7564c5..c26df34 100644 --- a/README.adoc +++ b/README.adoc @@ -1,14 +1,11 @@ -= Antora Default UI += Stackable UI based on Antora Default UI // Settings: :experimental: :hide-uri-scheme: // Project URLs: :url-project: https://gitlab.com/antora/antora-ui-default -:url-preview: https://antora.gitlab.io/antora-ui-default -:url-ci-pipelines: {url-project}/pipelines -:img-ci-status: {url-project}/badges/master/pipeline.svg // External URLs: -:url-antora: https://antora.org +:url-stackable-docs: https://docs.stackable.tech/ :url-antora-docs: https://docs.antora.org :url-git: https://git-scm.com :url-git-dl: {url-git}/downloads @@ -19,13 +16,12 @@ :url-nvm-install: {url-nvm}#installation :url-source-maps: https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map -image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}] +This project is the UI template used on {url-stackable-docs}[the Stackable docs]. It is based on the Antora default UI. As intended, this repository is forked from the default UI and customized to our needs. -This project is an archetype that demonstrates how to produce a UI bundle that can be used by {url-antora}[Antora] to generated a documentation site. -You can see a preview of the default UI at {url-preview}. +== Notes on our Customized Version -While the default UI is ready to be used with Antora, the intent is that you'll fork it and customize it for your own needs. -It's intentionally minimalistic so as to give you a good starting point without requiring too much effort to customize. +=== Tracking +We have added our own tracking solution into `src/partials/head-scripts.hbs`. It has the URL hardcoded. it can be enabled by setting `site.keys.enable_tracking` to `true`/`false` in the Antora playbook. == Code of Conduct