From 880552ac0a4e641b62ffb4113ea0810fd5d00aa5 Mon Sep 17 00:00:00 2001 From: sven Date: Sun, 20 Apr 2025 18:34:16 +0200 Subject: [PATCH] feat: :sparkles: New docs setup --- .gitignore | 5 ++++- antora-playbook.yml | 17 +++++++++++++++++ docs/antora.yml | 5 +++++ docs/modules/ROOT/nav.adoc | 1 + docs/modules/ROOT/pages/index.adoc | 3 +++ ui/ui.yml | 2 ++ 6 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 antora-playbook.yml create mode 100644 docs/antora.yml create mode 100644 docs/modules/ROOT/nav.adoc create mode 100644 docs/modules/ROOT/pages/index.adoc create mode 100644 ui/ui.yml diff --git a/.gitignore b/.gitignore index 72230c5..f2897fb 100644 --- a/.gitignore +++ b/.gitignore @@ -136,4 +136,7 @@ dist .pnp.* # Setup and configuration -.direnv \ No newline at end of file +.direnv + +# Antora +build/site/ \ No newline at end of file diff --git a/antora-playbook.yml b/antora-playbook.yml new file mode 100644 index 0000000..4984d6b --- /dev/null +++ b/antora-playbook.yml @@ -0,0 +1,17 @@ +site: + title: My Project Docs + start_page: my-component::index.adoc + +content: + sources: + - url: . + branches: HEAD + start_path: docs + +ui: + bundle: + dir: ./ui + snapshot: true + +output: + dir: ./build/site diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 0000000..fc0a9ba --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,5 @@ +name: my-component +title: My Docs +version: latest +nav: + - modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..5d67faa --- /dev/null +++ b/docs/modules/ROOT/nav.adoc @@ -0,0 +1 @@ +* xref:index.adoc[Home] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000..6abd914 --- /dev/null +++ b/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1,3 @@ += Welcome to My Docs + +This is a sample Antora documentation page. diff --git a/ui/ui.yml b/ui/ui.yml new file mode 100644 index 0000000..429211a --- /dev/null +++ b/ui/ui.yml @@ -0,0 +1,2 @@ +name: my-custom-ui +version: 1.0.0