Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate reference documentation to Antora #390

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added antora yaml files.
  • Loading branch information
pderop committed Jun 5, 2024
commit 8a28b2de211c8fdfc02fdb6b40c6d1c45e9527cf
9 changes: 9 additions & 0 deletions docs/antora-assembler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root_level: 0
build:
publish: false
asciidoc:
build:
command: bundle exec asciidoctor-pdf -n -d book
attributes:
source-highlighter: rouge
pdf-theme: ./pdf-theme.yml
52 changes: 52 additions & 0 deletions docs/antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
antora:
extensions:
- '@springio/antora-extensions/partial-build-extension'
# atlas-extension must be before latest-version-extension so latest versions are applied to imported versions
- '@antora/atlas-extension'
- require: '@springio/antora-extensions/latest-version-extension'
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
- '@antora/collector-extension'
- id: pdf-extension # pdf-extension is enabled from antora-docs.gradle
require: '@antora/pdf-extension'
enabled: false
- require: '@springio/antora-extensions/root-component-extension'
root_component_name: 'reactor-kafka'
site:
title: Reactor Kafka Reference Guide
url: https://projectreactor.io/docs/kafka/release/reference
content:
sources:
- url: ./..
branches: HEAD
start_path: docs
worktrees: true
asciidoc:
extensions:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
attributes:
page-stackoverflow-url: https://stackoverflow.com/tags/reactor-kafka
page-pagination: ''
hide-uri-scheme: '@'
tabs-sync-option: '@'
chomp: 'all'
doctype: book
icons: font
toc2: true
sectnums: true
sectanchors: true
numbered: true
source-highlighter: highlightjs
highlightjsdir: modules/ROOT/assets/highlight
highlightjs-theme: railscasts
sourcemap: true
urls:
latest_version_segment: ''
runtime:
log:
failure_level: warn
format: pretty
ui:
bundle:
url: https://github.com/reactor/antora-ui-projectreactor/releases/download/latest/ui-bundle.zip
snapshot: true
27 changes: 27 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: reactor-kafka
version: true
title: Reactor Kafka Reference Guide
start_page: overview.adoc
nav:
- modules/ROOT/nav.adoc
ext:
collector:
run:
command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :docs:generateAntoraResources
local: true
scan:
dir: ./build/generated-antora-resources

asciidoc:
attributes:
attribute-missing: 'warn'
chomp: 'all'
source-language: java
github-repo: reactor/reactor-kafka
github-code: https://github.com/{github-repo}
javadoc: 'https://projectreactor.io/docs/kafka/{project-version}/api'
author:
- Rajini Sivaram
- Mark Pollack
- Oleh Dokuka
- Gary Russell
4 changes: 4 additions & 0 deletions docs/pdf-theme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
extends: default
role:
red:
font-color: #FF0000