Link published mdBook manuals from project READMEs
Beffroi/beffroi-tools/pipeline/head This commit looks good
Details
Beffroi/beffroi-tools/pipeline/head This commit looks good
Details
This commit is contained in:
parent
dd9f7ad40c
commit
5b501af6f7
14
README.md
14
README.md
|
|
@ -12,7 +12,7 @@
|
|||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/releases.md">Portable releases</a> ·
|
||||
<a href="#quick-start">Quick start</a> ·
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/README.md">Documentation</a> ·
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/manuals/README.md">Manuals</a> ·
|
||||
<a href="https://books.dandaedre.com/manuals/">Full manuals</a> ·
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/changelogs.md">What's new</a> ·
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/development/README.md">Development</a>
|
||||
</p>
|
||||
|
|
@ -26,14 +26,14 @@
|
|||
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/README.md">PPTX Reporter</a></h3>
|
||||
<p>Inspect presentation videos, read playback timings, and export reports or Ontime rundowns.</p>
|
||||
<p><strong>Desktop app · CLI</strong></p>
|
||||
<p><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/visual-guide.md">Visual walkthrough</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/README.md">Guide</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/report-formats.md">Report formats</a></p>
|
||||
<p><a href="https://books.dandaedre.com/manuals/pptx-reporter/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/visual-guide.md">Visual walkthrough</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/README.md">Guide</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/pptx-reporter/report-formats.md">Report formats</a></p>
|
||||
</td>
|
||||
<td width="50%" valign="top">
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md"><img src="crates/rundown-converter/assets/app-icon.png" width="72" height="72" alt="Rundown Converter icon"></a>
|
||||
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md">Rundown Converter</a></h3>
|
||||
<p>Turn spreadsheet rundowns into Ontime schedules, with timing checks before export.</p>
|
||||
<p><strong>Desktop app · CLI</strong></p>
|
||||
<p><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md">Guide</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/corpus.md">Sample findings</a></p>
|
||||
<p><a href="https://books.dandaedre.com/manuals/rundown-converter/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/README.md">Guide</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/rundown-converter/corpus.md">Sample findings</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -42,14 +42,14 @@
|
|||
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/midra-layout/README.md">Midra Layout</a></h3>
|
||||
<p>Arrange screen layers, exchange geometry, and review transfers to an Eikos 4K device.</p>
|
||||
<p><strong>Desktop app</strong></p>
|
||||
<p><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/midra-layout/README.md">Guide</a> · <a href="#midra-layout-templates">Templates</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/interfaces/midra-layout-exchange.md">Geometry formats</a></p>
|
||||
<p><a href="https://books.dandaedre.com/manuals/midra-layout/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/midra-layout/README.md">Guide</a> · <a href="#midra-layout-templates">Templates</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/interfaces/midra-layout-exchange.md">Geometry formats</a></p>
|
||||
</td>
|
||||
<td valign="top">
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md"><img src="crates/ascii-names/assets/app-icon.png" width="72" height="72" alt="ASCII Names icon"></a>
|
||||
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md">ASCII Names</a></h3>
|
||||
<p>Clean up filenames to ASCII with paced renames, collision protection, and unchanged file contents.</p>
|
||||
<p><strong>Desktop app · CLI</strong></p>
|
||||
<p><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md">Guide</a></p>
|
||||
<p><a href="https://books.dandaedre.com/manuals/ascii-names/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/ascii-names/README.md">Guide</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -58,14 +58,14 @@
|
|||
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/exporter/README.md">Document Exporter</a></h3>
|
||||
<p>Export PPTX to PDF or slide images, render PDF pages, and compress PDFs to a target size.</p>
|
||||
<p><strong>Python CLI</strong></p>
|
||||
<p><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/exporter/README.md">Guide and dependencies</a></p>
|
||||
<p><a href="https://books.dandaedre.com/manuals/exporter/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/docs/exporter/README.md">Guide and dependencies</a></p>
|
||||
</td>
|
||||
<td valign="top">
|
||||
<a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md"><img src="companion-modules/media-player-classic/companion/assets/app-icon.png" width="72" height="72" alt="MPC-HC Companion icon"></a>
|
||||
<h3><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md">MPC-HC Companion</a></h3>
|
||||
<p>Control Media Player Classic Home Cinema from Companion with playback actions and player feedback.</p>
|
||||
<p><strong>Companion 5.1 module</strong></p>
|
||||
<p><a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md">Setup and development</a></p>
|
||||
<p><a href="https://books.dandaedre.com/manuals/media-player-classic/">Full manual</a> · <a href="https://proxy.dandaedre.com/gitea/Beffroi/beffroi-tools/src/branch/main/companion-modules/media-player-classic/README.md">Setup and development</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# MPC-HC Companion module — local development
|
||||
|
||||
[Read the full manual →](https://books.dandaedre.com/manuals/media-player-classic/)
|
||||
|
||||
<img src="companion/assets/app-icon.png" width="96" alt="Media Player Classic module icon">
|
||||
|
||||
A local development port of the original Media Player Classic module for
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
[Project portal](../README.md) · [Changelogs](changelogs.md) · [Development](development/README.md)
|
||||
|
||||
**[Read the full manuals →](https://books.dandaedre.com/manuals/)** — searchable mdBook documentation for all six tools.
|
||||
|
||||
## Tools
|
||||
|
||||
| Tool | Start here | Reference and background |
|
||||
|
|
@ -15,7 +17,7 @@
|
|||
|
||||
## Shared resources
|
||||
|
||||
- **mdBook manuals:** [all six manuals, local preview and Jenkins publication](manuals/README.md).
|
||||
- **mdBook manuals:** [read online](https://books.dandaedre.com/manuals/) · [build, local preview and Jenkins publication](manuals/README.md).
|
||||
|
||||
- **Development:** [setup and checks](development/README.md), [CI and coverage](development/ci.md), [builds and portable releases](development/releases.md), [application artwork](development/releases.md#application-artwork).
|
||||
- **File and device contracts:** [interface index](interfaces/README.md), including versioned examples and compatibility rules.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# ASCII names
|
||||
|
||||
[Read the full manual →](https://books.dandaedre.com/manuals/ascii-names/)
|
||||
|
||||
[Documentation](../README.md) · [Changelog](changelog.md)
|
||||
|
||||
<img src="../../crates/ascii-names/assets/app-icon.png" width="96" alt="Application icon">
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes.
|
||||
|
||||
- Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage.
|
||||
|
||||
- Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# Export presentations and PDF pages
|
||||
|
||||
[Read the full manual →](https://books.dandaedre.com/manuals/exporter/)
|
||||
|
||||
[Documentation](../README.md) · [Changelog](changelog.md)
|
||||
|
||||
<img src="../../tools/assets/exporter/app-icon.png" width="96" alt="Application icon">
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes.
|
||||
|
||||
- Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage.
|
||||
|
||||
- Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist.
|
||||
|
|
|
|||
|
|
@ -2,22 +2,24 @@
|
|||
|
||||
[Documentation](../README.md) · [CI and coverage](../development/ci.md)
|
||||
|
||||
**[Read all manuals online →](https://books.dandaedre.com/manuals/)**
|
||||
|
||||
Each project has an mdBook manual, built from the existing documentation. Edit the
|
||||
original guides; the build stages them without creating a second maintained copy.
|
||||
The published landing page includes all six project icons and manual links.
|
||||
|
||||
| Manual | Contents | Published directory |
|
||||
| Manual | Read online | Chapter sources |
|
||||
| --- | --- | --- |
|
||||
| ASCII Names | [Chapter list](ascii-names/SUMMARY.md) | `/mnt/books/manuals/ascii-names/` |
|
||||
| Document Exporter | [Chapter list](exporter/SUMMARY.md) | `/mnt/books/manuals/exporter/` |
|
||||
| MPC-HC Companion | [Chapter list](media-player-classic/SUMMARY.md) | `/mnt/books/manuals/media-player-classic/` |
|
||||
| Midra Layout | [Chapter list](midra-layout/SUMMARY.md) | `/mnt/books/manuals/midra-layout/` |
|
||||
| PPTX Reporter | [Chapter list](pptx-reporter/SUMMARY.md) | `/mnt/books/manuals/pptx-reporter/` |
|
||||
| Rundown Converter | [Chapter list](rundown-converter/SUMMARY.md) | `/mnt/books/manuals/rundown-converter/` |
|
||||
| ASCII Names | [Full manual](https://books.dandaedre.com/manuals/ascii-names/) | [Chapter list](ascii-names/SUMMARY.md) |
|
||||
| Document Exporter | [Full manual](https://books.dandaedre.com/manuals/exporter/) | [Chapter list](exporter/SUMMARY.md) |
|
||||
| MPC-HC Companion | [Full manual](https://books.dandaedre.com/manuals/media-player-classic/) | [Chapter list](media-player-classic/SUMMARY.md) |
|
||||
| Midra Layout | [Full manual](https://books.dandaedre.com/manuals/midra-layout/) | [Chapter list](midra-layout/SUMMARY.md) |
|
||||
| PPTX Reporter | [Full manual](https://books.dandaedre.com/manuals/pptx-reporter/) | [Chapter list](pptx-reporter/SUMMARY.md) |
|
||||
| Rundown Converter | [Full manual](https://books.dandaedre.com/manuals/rundown-converter/) | [Chapter list](rundown-converter/SUMMARY.md) |
|
||||
|
||||
The landing page is `/mnt/books/manuals/index.html`. The books assume the books
|
||||
server exposes that directory as `/manuals/`; each `book.toml` declares the
|
||||
corresponding `site-url` for its 404 page. No public hostname is hardcoded.
|
||||
The published site is served from `/mnt/books/manuals/` at
|
||||
https://books.dandaedre.com/manuals/. Each `book.toml` declares a relative
|
||||
`site-url` for its 404 page, so local previews also work.
|
||||
|
||||
## Build and preview
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes.
|
||||
|
||||
- Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage.
|
||||
|
||||
- Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# Midra Layout
|
||||
|
||||
[Read the full manual →](https://books.dandaedre.com/manuals/midra-layout/)
|
||||
|
||||
<img src="../../crates/midra-layout/assets/app-icon.png" width="96" alt="Midra Layout icon">
|
||||
|
||||
Midra Layout helps you prepare screen layouts for presentations and live events.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes.
|
||||
|
||||
- Mark PPTX, draw.io and SVG format acceptance as solved following the user's confirmation that all three work (2026-11-14).
|
||||
|
||||
- Replace the incomplete DXF skeleton with the official shared Craft DXF document writer/reader; add optional Craft DWG exchange with the same pixel geometry and canvas limits. Refresh CAD starter files and cover document structure, binary DXF and DWG round trips. Add a byte-preserving ZIP of the AI templates to bypass Gitea/browser PDF preview downloads.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# PPTX reporter
|
||||
|
||||
[Read the full manual →](https://books.dandaedre.com/manuals/pptx-reporter/)
|
||||
|
||||
[Documentation](../README.md) · [Changelog](changelog.md) · [Visual walkthrough](visual-guide.md) · [Report formats](report-formats.md)
|
||||
|
||||
<img src="../../crates/pptx-reporter/assets/app-icon.png" width="96" alt="Application icon">
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes.
|
||||
|
||||
- Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage.
|
||||
|
||||
- Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
# Rundown converter
|
||||
|
||||
[Read the full manual →](https://books.dandaedre.com/manuals/rundown-converter/)
|
||||
|
||||
[Documentation](../README.md) · [Changelog](changelog.md) · [Corpus findings](corpus.md) · [Plan](plan.md)
|
||||
|
||||
<img src="../../crates/rundown-converter/assets/app-icon.png" width="96" alt="Application icon">
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## Unreleased
|
||||
|
||||
- Add direct links to the published mdBook manual from the project README, tool guide and documentation indexes.
|
||||
|
||||
- Add an mdBook manual built from the existing guides, with local assets and downloads. Jenkins publishes successful main builds under `/mnt/books/manuals/`; staging, link validation and scoped publication have regression coverage.
|
||||
|
||||
- Use absolute Gitea main-branch URLs for repository file links in the root README; verify linked files exist.
|
||||
|
|
|
|||
Loading…
Reference in New Issue