Skip to content

Commit 71175a7

Browse files
committed
Created antora docs folder structure
1 parent 325c66b commit 71175a7

File tree

5 files changed

+95
-0
lines changed

5 files changed

+95
-0
lines changed

docs/_playbook/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build
2+
node_modules
3+
.vscode
4+
vale
5+
package-lock.json

docs/_playbook/.vale.ini

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
StylesPath = vale
2+
3+
MinAlertLevel = suggestion
4+
5+
Packages = http://github.com/AxonIQ/axoniq-vale-package/releases/latest/download/axoniq-vale-package.zip
6+
7+
Vocab = general, AxonIQ, Java, Names_Terms, misc
8+
9+
[*.{adoc,html}]
10+
BasedOnStyles = AxonIQ, proselint, Google
11+
12+
Google.Headings = NO # Diasable in favor od AxonIQ one
13+
Google.Parens = NO # Disable warning about using parens
14+
Google.Quotes = NO # Diasable "commas and periods go inside quotation marks"
15+
Google.WordList = NO # Disable Google's word list
16+
Google.Passive = NO # Allow the use of Passive voice
17+
Google.Colons = NO # Allow the use of Colons
18+
Google.Will = NO # Allow use will
19+
Google.Contractions = NO
20+
Google.We = NO
21+
22+
23+

docs/_playbook/package.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"devDependencies": {
3+
"@antora/atlas-extension": "^1.0.0-alpha.2",
4+
"@antora/cli": "^3.2.0-alpha.2",
5+
"@antora/lunr-extension": "^1.0.0-alpha.8",
6+
"@antora/site-generator": "^3.2.0-alpha.2",
7+
"@asciidoctor/tabs": "^1.0.0-beta.6",
8+
"@axoniq/antora-vale-extension": "^0.1.1",
9+
"asciidoctor-kroki": "^0.17.0"
10+
}
11+
}

docs/_playbook/playbook.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
site:
2+
title: Spring AOT Extension docs PREVIEW
3+
start_page: springaot_extension_guide::index.adoc
4+
5+
content:
6+
sources:
7+
- url: ../..
8+
start_paths: ['docs/*', '!docs/_*']
9+
10+
asciidoc:
11+
attributes:
12+
experimental: true
13+
page-pagination: true
14+
kroki-fetch-diagram: true
15+
# primary-site-manifest-url: https://library.axoniq.io/site-manifest.json
16+
extensions:
17+
- asciidoctor-kroki
18+
- '@asciidoctor/tabs'
19+
20+
antora:
21+
extensions:
22+
- id: prose-linting
23+
require: '@axoniq/antora-vale-extension'
24+
enabled: true
25+
vale_config: .vale.ini
26+
update_styles: true
27+
- id: lunr
28+
require: '@antora/lunr-extension'
29+
enabled: true
30+
index_latest_only: true
31+
- id: atlas
32+
require: '@antora/atlas-extension'
33+
34+
runtime:
35+
fetch: true # fetch remote repos
36+
log:
37+
level: info
38+
failure_level: error
39+
40+
ui:
41+
bundle:
42+
url: https://github.com/AxonIQ/axoniq-library-ui/releases/download/v.0.1.10/ui-bundle.zip

docs/extension-guide/antora.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: springaot_extension_guide
2+
title: Spring AOT Extension Guide
3+
version: true
4+
prerelease: true
5+
start_page: ROOT:index.adoc
6+
7+
asciidoc:
8+
attributes:
9+
component_description: The Spring AOT Extension guide from the former reference guide
10+
type: guide
11+
group: axon-framework
12+
13+
nav:
14+
- modules/nav.adoc

0 commit comments

Comments
 (0)