documentation/docs/_config.yml at main · twinbasic/documentation · 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
106
107
108
title: twinBASIC Documentation
logo: favicon.png
logo_with_title: true
url: "https://docs.twinbasic.com"

# Aux links for the upper right navigation
aux_links:
  "twinBASIC Home":
    - "https://www.twinbasic.com"

# External navigation links
nav_external_links:
  - title: twinBASIC Home
    url: https://www.twinbasic.com

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

footer_content: 'Copyright &copy; 2025 TWINBASIC LTD (Company No. 16590181, VAT No. GB497509439)'

# Footer last edited timestamp -- page must have `last_modified_date`
# defined in the frontmatter for the value to render.
last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p"

# Footer "Edit this page on GitHub" link
gh_edit_link: true
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/twinbasic/documentation/"
gh_edit_branch: "main"
gh_edit_source: docs
gh_edit_view_mode: "tree"

# Footer "Download offline copy" link -- points at the offline-site
# zip attached to the latest GitHub release (cut by the manual
# `workflow_dispatch` path in .github/workflows/jekyll-gh-pages.yml).
# Rendered inside the same flex row as the "Edit this page" link,
# with id="download-offline" on the <a>. Emitted in both the online
# _site/ and the offline _site-offline/ trees -- online readers use
# it to fetch the offline copy, offline readers use it to refresh
# theirs against the latest release.
gh_offline_link: true
gh_offline_link_url: "https://github.com/twinbasic/documentation/releases/latest/download/twinbasic-docs-offline.zip"
gh_pdf_link_url: "https://github.com/twinbasic/documentation/releases/latest/download/twinBASIC.Book.pdf"

# When true, tbdocs's Phase 7 writes a `file://`-browsable mirror of
# `_site/` to `_site-offline/` with every URL rewritten to a page-
# relative form. The online `_site/` output is unaffected.
also_build_offline: true

# When true, tbdocs's Phase 8 writes a sparse `_site-pdf/` tree
# containing the inputs `render-book.mjs` needs to render the PDF
# book: `book.html`, the two stylesheets the book layout links
# (`print.css`, `tb-highlight.css`), and every image referenced from
# `book.html`. `docs/book.bat` does the actual PDF render. The online
# `_site/` output is unaffected.
also_build_pdf: true

# Files written to `_site/` that have no purpose in the offline tree --
# Pages / crawler metadata and the concatenated `book.html` that feeds
# the PDF build. tbdocs's Phase 7 skips these when mirroring to
# `_site-offline/`.
#
# Patterns are fnmatch-style with PATHNAME semantics, matched against
# each file's path relative to the site root. `*` does NOT cross
# directory separators (so `*.bat` only catches top-level .bat files);
# use `**/*.bat` to catch them at any depth.
offline_exclude:
  - CNAME
  - robots.txt
  - sitemap.xml
  - book.html
  - assets/js/search-data.json

# Files and patterns that tbdocs's discover phase excludes from the source
# tree. Uses fast-glob syntax: ** crosses directory separators, * stays
# within one level. Same role as Jekyll's built-in `exclude:` list.
#
# Patterns that start with * must be quoted so YAML does not interpret them
# as alias references.
# Extra files from outside the docs tree to bundle as site assets.
# Each entry maps a source path (relative to docs/) to a destination
# path in the built site.  Injected during the discover phase.
bundle_extra:
  - src: ../scripts/impexp.mjs
    dest: Features/Packages/downloads/impexp.mjs
  - src: ../scripts/impexp.py
    dest: Features/Packages/downloads/impexp.py

exclude:
  # Underscore-prefixed files and directories -- catches _config.yml,
  # _book.yml, _site, _site-offline, _site-pdf, _pdf, _includes,
  # _layouts, _sass, _plugins, _profile, and every _Images at any depth.
  - _*
  - _*/**
  - "**/_*/**"
  # Defensive: caches and unrelated trees that should never be in docs/.
  - "**/.git/**"
  - "**/node_modules/**"
  - "**/.jekyll-cache/**"
  - "**/.sass-cache/**"
  # SCSS sources -- compiled by builder/scss.mjs into the just-the-docs
  # stylesheet; the .scss itself is not a deployable asset.
  - "**/*.scss"
  # Graphviz/DOT source files -- the build outputs .svg counterparts via
  # builder/dot.mjs; the .dot sources are not part of the published site.
  - "**/*.dot"