docs.owncloud.com/site.yml at main · owncloud/docs.owncloud.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site:
  title: Documentation for ownCloud (A Kiteworks Company)
  # Deploy target is GitHub Pages on the custom domain doc.owncloud.com, served
  # at the domain ROOT (no repo subpath). This URL drives canonical links (used
  # by the Pagefind dedup layout in ui/supplemental/layouts/default.hbs), the
  # sitemap written by antora-extensions/sitemap-cleanup.js, and the navbar logo
  # link -- it must match the real publish location. Local preview overrides it
  # via `npm run antora-local` (--url http://localhost:8080).
  url: https://doc.owncloud.com
  # the site's landing page resides in the main content component
  # but it MUST be named ROOT to get a component/version-less landing page.
  # see: https://docs.antora.org/antora/latest/page/start-page/
  # see: https://docs.antora.org/antora/latest/component-name-key/#root-component
  start_page: ROOT::index.adoc

# All content is local now (monorepo). No remote GitHub sources, no branches.
# Each product is a component; each version is a folder carrying its own antora.yml.
content:
  sources:
  - url: .
    start_paths:
    # for any components (such as ocis) where versions to render are defined manually,
    # you must define e.g. `content/ocis/9.0` and not `content/ocis/9.0/*`
    # otherwise this globs one level too deep, into modules/, and Antora then aborts
    # with "antora.yml not found".
    # note that any version NOT named is not rendered and could safely be deleted if outdated.
    # note that sometimes outdated versions may not render at all because of attribute changes.
    - content/main
    - content/server/*
    - content/ocis/9.0
    - content/ocis/8.2
    - content/ocis/8.1
    - content/webui
    - content/desktop/*
    - content/ios/*
    - content/android/*

urls:
  # https://docs.antora.org/antora/latest/playbook/urls-redirect-facility/
  redirect_facility: static
  # Every version is published at its real, explicit URL (e.g. /server/10.16/).
  # We deliberately do NOT set latest_version_segment: Antora's built-in latest
  # handling either hides the real version (`replace`) or is ignored on a static
  # host (`redirect:from` is a no-op under redirect_facility: static). Instead,
  # antora-extensions/latest-alias.js publishes a `latest` segment as a tree of
  # static meta-refresh redirect stubs pointing at each component's latest
  # non-prerelease version -- explicit real URLs AND a working /…/latest/.
  # antora-extensions/next-alias.js publishes a `next` segment the same way, for
  # the legacy `…/next/…` URLs (the old per-product `master` builds); it points at
  # each component's prerelease version, falling back to the latest release.

runtime:
  # local content only, no other git repos to fetch
  fetch: false
  cache_dir: ./.cache

output:
  clean: true
  dir: public

ui:
  output_dir: assets
  # Stock Antora default UI -- no custom build on our side.
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true
  # Branding + behaviors (logo, colors, tabs, copy-to-clipboard, Pagefind widget)
  # layered on at build time.
  supplemental_files: ./ui/supplemental

asciidoc:
  attributes:
#   global attributes loaded via antora extension (load-global-site-attributes)
  extensions:
    - ./asciidoc-extensions/tabs.js
    - ./asciidoc-extensions/remote-include-processor.js
    - asciidoctor-kroki # integrated via npm

antora:
  extensions:
    - ./antora-extensions/comp-version.js
    - ./antora-extensions/latest-alias.js
    - ./antora-extensions/next-alias.js
    # Antora derives page-component-version-is-latest but has no prerelease
    # counterpart; this adds page-component-version-is-prerelease, set on every
    # page of a version marked `prerelease` in its antora.yml (ocis 8.3,
    # desktop 7.2, android 4.8 today), so content can branch on "this is the dev
    # line" without hard-coding a version number.
    - ./antora-extensions/prerelease-attribute.js
    - require: ./antora-extensions/load-global-site-attributes.js
      attributefile: ./global-attributes.yml
      enabled: true
    - require: ./antora-extensions/sitemap-cleanup.js
      # Keep only each component's latest non-prerelease version in the sitemap
      # (the /…/latest/ redirect target). Real version URLs are published but
      # de-duplicated out of the sitemap; canonical still points at these pages.
      mode: latest-per-component
      printsitemapfound: true
      printcontent: false
      enabled: true
    - require: '@sntke/antora-mermaid-extension'
      mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs
      script_stem: header-scripts
      mermaid_initialize_options:
      start_on_load: true