|
| 1 | +# npx antora --clean --fetch antora-playbook.yml |
| 2 | +# or |
| 3 | +# npx antora antora-playbook.yml |
| 4 | +antora: |
| 5 | + extensions: |
| 6 | + - '@antora/site-generator-ms' |
| 7 | + - ./lib/embargo.js |
| 8 | + - ./lib/antora-component-version-rank.js |
| 9 | + - "@antora/collector-extension" |
| 10 | +site: |
| 11 | + title: Couchbase Docs |
| 12 | + url: https://docs.couchbase.com/wibble/ |
| 13 | + start_page: home::index.adoc |
| 14 | + robots: allow |
| 15 | + keys: |
| 16 | + google_analytics: GTM-MVPNN2 |
| 17 | + nav_groups: | |
| 18 | + [ |
| 19 | + { "title": "Server", "startPage": "home::server.adoc", "components": ["server"] }, |
| 20 | + { "title": "Mobile", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "sync-gateway"] }, |
| 21 | + { "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "columnar"] }, |
| 22 | + { "title": "Cloud-Native", "startPage": "cloud-native-database::index.adoc", "components": ["cloud-native-database"] }, |
| 23 | + { "title": "Autonomous Operator", "components": ["operator"] }, |
| 24 | + { "title": "CMOS", "components": ["cmos"] }, |
| 25 | + { "title": "SDKs", "startPage": "home::sdk.adoc", "components": ["*-sdk", "cxx-txns", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "sdk-extensions"] }, |
| 26 | + { "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] }, |
| 27 | + { "title": "Contribute", "components": ["home", "styleguide", "ui-ux", "pendo"] } |
| 28 | + ] |
| 29 | +git: |
| 30 | + ensure_git_suffix: false |
| 31 | + fetch_concurrency: 1 |
| 32 | +urls: |
| 33 | + latest_version_segment_strategy: redirect:to |
| 34 | + latest_version_segment: current |
| 35 | +content: |
| 36 | + branches: master |
| 37 | + # NOTE the git@ segment in the URL indicates which repositories are private |
| 38 | + ## The above has a bug when upgrading to Antora 3.1. Original sources commented |
| 39 | + ## out and replaced with a non git@ prefix. To revert if it causes issues |
| 40 | + sources: |
| 41 | + - url: . |
| 42 | + branches: HEAD |
| 43 | + start_path: home |
| 44 | + - url: https://github.com/couchbaselabs/docs-columnar.git |
| 45 | + branches: AV-86739-Docs-for-Support-Superset-BI-tool-with-Columnar |
| 46 | + - url: https://github.com/couchbase/docs-connectors-superset.git |
| 47 | + branches: release/1.0 |
| 48 | +asciidoc: |
| 49 | + attributes: |
| 50 | + site-navigation-data-path: _/js/site-navigation-data.js |
| 51 | + enable-cmos: '' |
| 52 | + max-include-depth: 10 |
| 53 | + page-partial: false |
| 54 | + experimental: '' |
| 55 | + idprefix: '@' |
| 56 | + idseparator: '-@' |
| 57 | + tabs: tabs |
| 58 | + tabs-sync-option: '' |
| 59 | + toc: ~ |
| 60 | + page-toclevels: 1@ |
| 61 | + page-rank: 50@ |
| 62 | + xrefstyle: short |
| 63 | + enterprise: https://www.couchbase.com/products/editions[ENTERPRISE EDITION] |
| 64 | + community: https://www.couchbase.com/products/editions[COMMUNITY EDITION] |
| 65 | + sqlpp: SQL++ |
| 66 | + sqlppc: SQL++ for Capella columnar |
| 67 | + sqlpp_url: https://www.couchbase.com/products/n1ql |
| 68 | + cbpp: Couchbase++ |
| 69 | + kroki-fetch-diagram: false |
| 70 | + # the url-issues and url-issues-* attributes configure the URLs for the inline jira macro |
| 71 | + url-issues: https://issues.couchbase.com/browse |
| 72 | + url-issues-jscbc: https://issues.couchbase.com/browse |
| 73 | + url-issues-av: https://couchbasecloud.atlassian.net/browse |
| 74 | + extensions: |
| 75 | + - ./lib/source-url-include-processor.js |
| 76 | + - ./lib/json-config-ui-block-macro.js |
| 77 | + - ./lib/inline-man-macro.js |
| 78 | + - ./lib/multirow-table-head-tree-processor.js |
| 79 | + - ./lib/swagger-ui-block-macro.js |
| 80 | + - ./lib/markdown-block.js |
| 81 | + - ./lib/template-block.js |
| 82 | + - asciidoctor-external-callout |
| 83 | + - '@asciidoctor/tabs' |
| 84 | +ui: |
| 85 | + bundle: |
| 86 | + url: https://github.com/couchbase/docs-ui/releases/download/prod-199/ui-bundle.zip |
| 87 | +output: |
| 88 | + dir: ./public |
0 commit comments