diff --git a/docs/Features/Advanced/Classes-and-Modules.md b/docs/Features/Advanced/Classes-and-Modules.md index 54242c51..7870ad4f 100644 --- a/docs/Features/Advanced/Classes-and-Modules.md +++ b/docs/Features/Advanced/Classes-and-Modules.md @@ -54,7 +54,7 @@ Public Function MyExportedFunction(ByVal arg As Long) As Long Public Function MyCDeclExport CDecl(ByVal arg As Long) ``` -This is primarily used to create Standard DLLs (see [Project Types](../Project-Configuration/Project-Types.md)), but this functionality is also available in Standard EXE and other compiled project types. +This is primarily used to create Standard DLLs (see [Project Types](../Project-Configuration/Project-Types)), but this functionality is also available in Standard EXE and other compiled project types. ## Create classes without `IDispatch` diff --git a/docs/Features/GUI-Components/Forms.md b/docs/Features/GUI-Components/Forms.md index 2356ac84..106e5120 100644 --- a/docs/Features/GUI-Components/Forms.md +++ b/docs/Features/GUI-Components/Forms.md @@ -41,7 +41,7 @@ In addition to the above, forms have: - Control anchoring: control x/y/cx/cy can made relative, so they're automatically moved/resized with the Form. For example if you put a TextBox in the bottom right, then check the Right and Bottom anchors (in addition to Top and Left), the bottom right will size with the form on resize. This saves a lot of boiler-plate sizing code. - Control docking: Controls can be fixed along one of the sides of the Form (or container), or made to fill the whole Form/container. Multiple controls can be combined and mixed/matched in docking positions. -For more information on Control Anchoring and Control Docking, see the [Anchoring and Docking page](Anchoring-Docking.md). +For more information on Control Anchoring and Control Docking, see the [Anchoring and Docking page](Anchoring-Docking). ## High Quality Scaling in Image Controls diff --git a/docs/Gemfile b/docs/Gemfile index f2a0d906..fbd01ea7 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -8,23 +8,17 @@ source "https://rubygems.org" gem "jekyll", "~> 4.2" gem "logger" gem "fiddle" -gem "nokogiri" gem "bigdecimal" -gem "rake" -gem "html-proofer" +gem "rake" # required at runtime by just-the-docs via jekyll-remote-theme group :jekyll_plugins do gem "jekyll-remote-theme", "= 0.4.3" gem "jekyll-sass-converter", "~> 2.2" gem "jekyll-seo-tag" gem "jekyll-include-cache" - gem "jekyll-titles-from-headings" gem "jekyll-sitemap" gem "jekyll-relative-links" gem "jekyll-redirect-from" - gem "jekyll-optional-front-matter" - gem "jekyll-github-metadata" - gem "jekyll-default-layout" gem "jekyll-gfm-admonitions" end diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 9f138f94..41b4b3ad 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,63 +1,25 @@ GEM remote: https://rubygems.org/ specs: - Ascii85 (2.0.1) addressable (2.8.8) public_suffix (>= 2.0.2, < 8.0) - afm (1.0.0) - async (2.35.0) - console (~> 1.29) - fiber-annotation - io-event (~> 1.11) - metrics (~> 0.12) - traces (~> 0.18) base64 (0.3.0) - benchmark (0.5.0) bigdecimal (4.0.1) colorator (1.1.0) concurrent-ruby (1.3.6) - console (1.34.2) - fiber-annotation - fiber-local (~> 1.1) - json cssminify (1.0.2) csv (3.3.5) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) - ethon (0.15.0) - ffi (>= 1.15.0) eventmachine (1.2.7) - faraday (2.14.0) - faraday-net_http (>= 2.0, < 3.5) - json - logger - faraday-net_http (3.4.2) - net-http (~> 0.5) - ffi (1.17.2) ffi (1.17.2-x64-mingw-ucrt) ffi (1.17.2-x86_64-linux-gnu) - fiber-annotation (0.2.0) - fiber-local (1.1.0) - fiber-storage - fiber-storage (1.0.1) fiddle (1.1.8) forwardable-extended (2.6.0) - hashery (2.1.2) - html-proofer (5.1.1) - addressable (~> 2.3) - async (~> 2.1) - benchmark (~> 0.5) - nokogiri (~> 1.13) - pdf-reader (~> 2.11) - rainbow (~> 3.0) - typhoeus (~> 1.3) - yell (~> 2.0) - zeitwerk (~> 2.5) http_parser.rb (0.8.1) i18n (1.14.8) concurrent-ruby (~> 1.0) - io-event (1.14.2) jekyll (4.4.1) addressable (~> 2.4) base64 (~> 0.2) @@ -77,19 +39,12 @@ GEM safe_yaml (~> 1.0) terminal-table (>= 1.8, < 4.0) webrick (~> 1.7) - jekyll-default-layout (0.1.5) - jekyll (>= 3.0, < 5.0) jekyll-gfm-admonitions (1.2.0) cssminify (~> 1.0) jekyll (>= 3.0, < 5.0) octicons (~> 19.8) - jekyll-github-metadata (2.16.1) - jekyll (>= 3.4, < 5.0) - octokit (>= 4, < 7, != 4.4.0) jekyll-include-cache (0.2.1) jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) jekyll-redirect-from (0.16.0) jekyll (>= 3.3, < 5.0) jekyll-relative-links (0.7.0) @@ -105,8 +60,6 @@ GEM jekyll (>= 3.8, < 5.0) jekyll-sitemap (1.4.0) jekyll (>= 3.7, < 5.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) json (2.18.0) @@ -120,62 +73,29 @@ GEM rb-inotify (~> 0.9, >= 0.9.10) logger (1.7.0) mercenary (0.4.0) - metrics (0.15.0) - mini_portile2 (2.8.9) - net-http (0.9.1) - uri (>= 0.11.1) - nokogiri (1.18.10) - mini_portile2 (~> 2.8.2) - racc (~> 1.4) - nokogiri (1.18.10-x64-mingw-ucrt) - racc (~> 1.4) - nokogiri (1.18.10-x86_64-linux-gnu) - racc (~> 1.4) octicons (19.21.1) - octokit (6.1.1) - faraday (>= 1, < 3) - sawyer (~> 0.9) pathutil (0.16.2) forwardable-extended (~> 2.6) - pdf-reader (2.15.0) - Ascii85 (>= 1.0, < 3.0, != 2.0.0) - afm (>= 0.2.1, < 2) - hashery (~> 2.0) - ruby-rc4 - ttfunk public_suffix (7.0.0) - racc (1.8.1) - rainbow (3.1.1) - rake (13.3.1) + rake (13.4.2) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) rexml (3.4.4) rouge (4.6.1) - ruby-rc4 (0.1.5) rubyzip (2.4.1) safe_yaml (1.0.5) sassc (2.4.0) ffi (~> 1.9) - sawyer (0.9.3) - addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) - traces (0.18.2) - ttfunk (1.7.0) - typhoeus (1.5.0) - ethon (>= 0.9.0, < 0.16.0) tzinfo (2.0.6) concurrent-ruby (~> 1.0) tzinfo-data (1.2025.3) tzinfo (>= 1.0.0) unicode-display_width (2.6.0) - uri (1.1.1) wdm (0.2.0) webrick (1.9.2) - yell (2.2.2) - zeitwerk (2.7.4) PLATFORMS x64-mingw-ucrt @@ -184,71 +104,46 @@ PLATFORMS DEPENDENCIES bigdecimal fiddle - html-proofer jekyll (~> 4.2) - jekyll-default-layout jekyll-gfm-admonitions - jekyll-github-metadata jekyll-include-cache - jekyll-optional-front-matter jekyll-redirect-from jekyll-relative-links jekyll-remote-theme (= 0.4.3) jekyll-sass-converter (~> 2.2) jekyll-seo-tag jekyll-sitemap - jekyll-titles-from-headings logger - nokogiri rake tzinfo (>= 1, < 3) tzinfo-data wdm (~> 0.1) CHECKSUMS - Ascii85 (2.0.1) sha256=15cb5d941808543cbb9e7e6aea3c8ec3877f154c3461e8b3673e97f7ecedbe5a addressable (2.8.8) sha256=7c13b8f9536cf6364c03b9d417c19986019e28f7c00ac8132da4eb0fe393b057 - afm (1.0.0) sha256=5bd4d6f6241e7014ef090985ec6f4c3e9745f6de0828ddd58bc1efdd138f4545 - async (2.35.0) sha256=0f792ce968023677669fb8608d0b16585332247181ed5417b4ff45900201e834 base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b - benchmark (0.5.0) sha256=465df122341aedcb81a2a24b4d3bd19b6c67c1530713fd533f3ff034e419236c bigdecimal (4.0.1) sha256=8b07d3d065a9f921c80ceaea7c9d4ae596697295b584c296fe599dd0ad01c4a7 colorator (1.1.0) sha256=e2f85daf57af47d740db2a32191d1bdfb0f6503a0dfbc8327d0c9154d5ddfc38 concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab - console (1.34.2) sha256=1c036abf606ccec83f9dc28f0c31710fe5936ffe7ba5d235ae2865590a482d58 cssminify (1.0.2) sha256=f574503558cd442c6286831ffdbebdb4587f6deb827ef7575f73f377a376a898 csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f em-websocket (0.5.3) sha256=f56a92bde4e6cb879256d58ee31f124181f68f8887bd14d53d5d9a292758c6a8 - ethon (0.15.0) sha256=0809805a035bc10f54162ca99f15ded49e428e0488bcfe1c08c821e18261a74d eventmachine (1.2.7) sha256=994016e42aa041477ba9cff45cbe50de2047f25dd418eba003e84f0d16560972 - faraday (2.14.0) sha256=8699cfe5d97e55268f2596f9a9d5a43736808a943714e3d9a53e6110593941cd - faraday-net_http (3.4.2) sha256=f147758260d3526939bf57ecf911682f94926a3666502e24c69992765875906c - ffi (1.17.2) sha256=297235842e5947cc3036ebe64077584bff583cd7a4e94e9a02fdec399ef46da6 ffi (1.17.2-x64-mingw-ucrt) sha256=15d2da54ee578657a333a6059ed16eaba1cbd794ceecd15944825b65c8381ac0 ffi (1.17.2-x86_64-linux-gnu) sha256=05d2026fc9dbb7cfd21a5934559f16293815b7ce0314846fee2ac8efbdb823ea - fiber-annotation (0.2.0) sha256=7abfadf1d119f508867d4103bf231c0354d019cc39a5738945dec2edadaf6c03 - fiber-local (1.1.0) sha256=c885f94f210fb9b05737de65d511136ea602e00c5105953748aa0f8793489f06 - fiber-storage (1.0.1) sha256=f48e5b6d8b0be96dac486332b55cee82240057065dc761c1ea692b2e719240e1 fiddle (1.1.8) sha256=7fa8ee3627271497f3add5503acdbc3f40b32f610fc1cf49634f083ef3f32eee forwardable-extended (2.6.0) sha256=1bec948c469bbddfadeb3bd90eb8c85f6e627a412a3e852acfd7eaedbac3ec97 - hashery (2.1.2) sha256=d239cc2310401903f6b79d458c2bbef5bf74c46f3f974ae9c1061fb74a404862 - html-proofer (5.1.1) sha256=f9baaae2268049918eb494b0a5b96e97f513a6b8490c185d11c371b60d9ecf86 http_parser.rb (0.8.1) sha256=9ae8df145b39aa5398b2f90090d651c67bd8e2ebfe4507c966579f641e11097a i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5 - io-event (1.14.2) sha256=b0a069190eafe86005c22f7464f744971b5bd82f153740d34e6ab49548d4f613 jekyll (4.4.1) sha256=4c1144d857a5b2b80d45b8cf5138289579a9f8136aadfa6dd684b31fe2bc18c1 - jekyll-default-layout (0.1.5) sha256=c626be4e4a5deafca123539da2cd22ff873be350cafd4da134039efdf24320af jekyll-gfm-admonitions (1.2.0) sha256=38b95c75449033465313a92c2da3ee311d3569f38e6053c635bc16d3c28e702d - jekyll-github-metadata (2.16.1) sha256=4cf29988bdaf24774a7bc07fae71e54424ddfaa2895f742d8fa3036d0db65b4c jekyll-include-cache (0.2.1) sha256=c7d4b9e551732a27442cb2ce853ba36a2f69c66603694b8c1184c99ab1a1a205 - jekyll-optional-front-matter (0.3.2) sha256=ecdc061d711472469fcf04da617653b553e914c038a17df3b6a5f6f92aeb761b jekyll-redirect-from (0.16.0) sha256=6635cae569ef9b0f90ffb71ec014ba977177fafb44d32a2b0526288d4d9be6db jekyll-relative-links (0.7.0) sha256=831e54c348eeae751845c0d4ac4b244bd73b664341f0e8c9f1803b16f4570835 jekyll-remote-theme (0.4.3) sha256=d3fde726484fb3df04de9e347baf75aaa3d5bfea771a330412e0c52608e54b40 jekyll-sass-converter (2.2.0) sha256=71894f61b1f062f9d56e90b83b29386c85af349749c5d6277a5ba4b2e69cfd1c jekyll-seo-tag (2.8.0) sha256=3f2ed1916d56f14ebfa38e24acde9b7c946df70cb183af2cb5f0598f21ae6818 jekyll-sitemap (1.4.0) sha256=0de08c5debc185ea5a8f980e1025c7cd3f8e0c35c8b6ef592f15c46235cf4218 - jekyll-titles-from-headings (0.5.3) sha256=77366754e361ea7b5d87881f5b1380835f5ce910c240a4d9ac2d7afe86d28481 jekyll-watch (2.2.1) sha256=bc44ed43f5e0a552836245a54dbff3ea7421ecc2856707e8a1ee203a8387a7e1 json (2.18.0) sha256=b10506aee4183f5cf49e0efc48073d7b75843ce3782c68dbeb763351c08fd505 kramdown (2.5.1) sha256=87bbb6abd9d3cebe4fc1f33e367c392b4500e6f8fa19dd61c0972cf4afe7368c @@ -257,41 +152,23 @@ CHECKSUMS listen (3.9.0) sha256=db9e4424e0e5834480385197c139cb6b0ae0ef28cc13310cfd1ca78377d59c67 logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203 mercenary (0.4.0) sha256=b25a1e4a59adca88665e08e24acf0af30da5b5d859f7d8f38fba52c28f405138 - metrics (0.15.0) sha256=61ded5bac95118e995b1bc9ed4a5f19bc9814928a312a85b200abbdac9039072 - mini_portile2 (2.8.9) sha256=0cd7c7f824e010c072e33f68bc02d85a00aeb6fce05bb4819c03dfd3c140c289 - net-http (0.9.1) sha256=25ba0b67c63e89df626ed8fac771d0ad24ad151a858af2cc8e6a716ca4336996 - nokogiri (1.18.10) sha256=d5cc0731008aa3b3a87b361203ea3d19b2069628cb55e46ac7d84a0445e69cc1 - nokogiri (1.18.10-x64-mingw-ucrt) sha256=64f40d4a41af9f7f83a4e236ad0cf8cca621b97e31f727b1bebdae565a653104 - nokogiri (1.18.10-x86_64-linux-gnu) sha256=ff5ba26ba2dbce5c04b9ea200777fd225061d7a3930548806f31db907e500f72 octicons (19.21.1) sha256=52f7330d7896fd18521999d1f6e9191f8b85ab22268b77e9f6d983a988556485 - octokit (6.1.1) sha256=920e4a9d820205f70738f58de6a7e6ef0e2f25b27db954b5806a63105207b0bf pathutil (0.16.2) sha256=e43b74365631cab4f6d5e4228f812927efc9cb2c71e62976edcb252ee948d589 - pdf-reader (2.15.0) sha256=c5025750bec8de7b11cfd1d1ccc2b944d2782c3638cd15b5ee1531d1206c0886 public_suffix (7.0.0) sha256=f7090b5beb0e56f9f10d79eed4d5fbe551b3b425da65877e075dad47a6a1b095 - racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f - rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a - rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c + rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701 rb-fsevent (0.11.2) sha256=43900b972e7301d6570f64b850a5aa67833ee7d87b458ee92805d56b7318aefe rb-inotify (0.11.1) sha256=a0a700441239b0ff18eb65e3866236cd78613d6b9f78fea1f9ac47a85e47be6e rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142 rouge (4.6.1) sha256=5075346d5797d6864be93f7adc75a16047a7dbfa572c63c502419ffa582c77de - ruby-rc4 (0.1.5) sha256=00cc40a39d20b53f5459e7ea006a92cf584e9bc275e2a6f7aa1515510e896c03 rubyzip (2.4.1) sha256=8577c88edc1fde8935eb91064c5cb1aef9ad5494b940cf19c775ee833e075615 safe_yaml (1.0.5) sha256=a6ac2d64b7eb027bdeeca1851fe7e7af0d668e133e8a88066a0c6f7087d9f848 sassc (2.4.0) sha256=4c60a2b0a3b36685c83b80d5789401c2f678c1652e3288315a1551d811d9f83e - sawyer (0.9.3) sha256=0d0f19298408047037638639fe62f4794483fb04320269169bd41af2bdcf5e41 terminal-table (3.0.2) sha256=f951b6af5f3e00203fb290a669e0a85c5dd5b051b3b023392ccfd67ba5abae91 - traces (0.18.2) sha256=80f1649cb4daace1d7174b81f3b3b7427af0b93047759ba349960cb8f315e214 - ttfunk (1.7.0) sha256=2370ba484b1891c70bdcafd3448cfd82a32dd794802d81d720a64c15d3ef2a96 - typhoeus (1.5.0) sha256=120b67ed1ef515e6c0e938176db880f15b0916f038e78ce2a66290f3f1de3e3b tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b tzinfo-data (1.2025.3) sha256=b546e2f1e5e5c40a0c619aafb24e30d3d6a128c2f689278f721b7286dd499562 unicode-display_width (2.6.0) sha256=12279874bba6d5e4d2728cef814b19197dbb10d7a7837a869bab65da943b7f5a - uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6 wdm (0.2.0) sha256=c46d9dcb6d375199ca07465bc67669ee8f041aeaa55dd7dafe6de4dd97b27647 webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131 - yell (2.2.2) sha256=1d166f3cc3b6dc49a59778ea7156ed6d8de794c15106d48ffd6cbb061b9b26bc - zeitwerk (2.7.4) sha256=2bef90f356bdafe9a6c2bd32bcd804f83a4f9b8bc27f3600fff051eb3edcec8b BUNDLED WITH 4.0.2 diff --git a/docs/IDE/Menu/Project.md b/docs/IDE/Menu/Project.md index 7c368466..f629bc67 100644 --- a/docs/IDE/Menu/Project.md +++ b/docs/IDE/Menu/Project.md @@ -20,16 +20,16 @@ permalink: /tB/IDE/Project/Menu/Project ## Add -**Add** is the same as Right Click Add on the [Project Explorer](../Project%20Explorer.md) +**Add** is the same as Right Click Add on the [Project Explorer](../Explorer)  ## References -See [Project Settings](../Project%20Settings.md) filtered by "project.references". +See [Project Settings](../Settings) filtered by "project.references".  ## Project Settings -See [Project Settings](../Project%20Settings.md). +See [Project Settings](../Settings). diff --git a/docs/IDE/Package Publishing.md b/docs/IDE/Package Publishing.md index 7228ba7c..d91d6e50 100644 --- a/docs/IDE/Package Publishing.md +++ b/docs/IDE/Package Publishing.md @@ -15,4 +15,4 @@ Once you open a project you will be able to edit the properties.  -Click the "EDIT" and this will open the [Project Settings](Project%20Settings.md) +Click the "EDIT" and this will open the [Project Settings](Settings) diff --git a/docs/IDE/Project Settings.md b/docs/IDE/Project Settings.md index b9c31cc7..d0091138 100644 --- a/docs/IDE/Project Settings.md +++ b/docs/IDE/Project Settings.md @@ -31,7 +31,7 @@ Listed below are the project settings, in the same order as they appear in the P  -See [Packages](../Features/Packages/index.md) +See [Packages](../../../Features/Packages/)  diff --git a/docs/Miscellaneous/Documentation Development.md b/docs/Miscellaneous/Documentation Development.md index d4b01335..cf340f9d 100644 --- a/docs/Miscellaneous/Documentation Development.md +++ b/docs/Miscellaneous/Documentation Development.md @@ -130,12 +130,10 @@ Before checking link integrity, the documentation must be built. This can be don To check that none of the internal links in the most recent documentation build are broken: - bundle exec htmlproofer ./_site --disable-external --no-enforce-https - -or, on Windows only - check.bat +This runs [Lychee](https://github.com/lycheeverse/lychee) in offline mode against the built `_site/`. + ### Building and Local Serving To build and serve the documentation from http://localhost:4000: diff --git a/docs/_config.yml b/docs/_config.yml index 0a4deb46..92bdd141 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -15,6 +15,10 @@ remote_theme: just-the-docs/just-the-docs@v0.10.1 highlighter: rouge defaults: + - scope: + path: "" + values: + layout: default - scope: path: "*/Images" values: @@ -22,7 +26,7 @@ defaults: - scope: path: "assets/css" values: - render_with_liquid: true + render_with_liquid: true # GitHub-style admonitions are supported, but we may wish to add custom # callouts below. @@ -31,11 +35,6 @@ callouts: # title: 💡 Tip # color: green -#defaults: -# - scope: -# path: "" -# values: -# layout: default #collections: # intro: diff --git a/docs/_includes/components/breadcrumbs.html b/docs/_includes/components/breadcrumbs.html new file mode 100644 index 00000000..0e54ea08 --- /dev/null +++ b/docs/_includes/components/breadcrumbs.html @@ -0,0 +1,35 @@ +{%- comment -%} + Shadow of just-the-docs's _includes/components/breadcrumbs.html. + + Renders the breadcrumb trail above each page's body by iterating the + precomputed chain attached to each page by + `_plugins/breadcrumbs-precompute.rb`. The upstream version walks the + cached site_nav HTML per page (~7 s across the site); offloading the + walk to Ruby makes this include essentially free. + + Expected data shape on `page.breadcrumb_chain`: + Array of { "title" => String, "url" => String }, ordered root-first + (the ancestor nearest the site root is at index 0). The current + page itself is not in the chain -- it is rendered separately as the + final `