Merge pull request #175 from timunie/housekeeping/ascii-doc-pdf-creator

Added a basic script to create pdf-files from ascii-doc ReadMe

Author: timunie

_docs/avalonia-docs-theme.yml

@@ -0,0 +1,39 @@
+extends: default
+base:
+  font-color: #222222
+  background-color: #ffffff
+  line-height: 1.5
+  paragraph-margin-bottom: 12
+heading:
+  font-color: #0063b1
+  font-style: bold
+  h1-font-size: 22
+  h2-font-size: 17
+  h3-font-size: 13
+  h4-font-size: 11
+link:
+  font-color: #0063b1
+  font-style: underline
+  font-weight: bold
+  role:
+    hover:
+      font-color: #40bfff
+code:
+  font-color: #2d7d46
+  background-color: #f3f3f3
+  border-radius: 4
+quote:
+  font-color: #3a4a5a
+  background-color: #f6f7fa
+  border-color: #0063b1
+  border-width: 4
+  border-style: solid
+table:
+  head-background-color: #f0f2f5
+  border-color: #d1d5db
+  background-color: #f6f7fa
+admonition:
+  border-color: #0063b1
+  background-color: #f6f7fa
+  title-font-color: #0063b1
+  title-font-weight: bold

scripts/Ascii-doc-pdf_creator.ps1

@@ -0,0 +1,23 @@
+# Compiles each .adoc file in all subdirectories (recursively) into a PDF using Asciidoctor-pdf.
+# If specific files are provided as arguments, only those files will be processed.
+
+param(
+    [Parameter(Mandatory=$false, ValueFromRemainingArguments=$true)]
+    [string[]]$InputFiles
+)
+
+# Find all .adoc files recursively
+if ($InputFiles -and $InputFiles.Count -gt 0) {
+    $adocFiles = $InputFiles | ForEach-Object { Get-Item $_ }
+} else {
+    $adocFiles = Get-ChildItem -Path ../. -Filter *.adoc -Recurse
+}
+
+$themePath = Join-Path -Path (Resolve-Path ../_docs) -ChildPath "avalonia-docs-theme.yml"
+
+foreach ($file in $adocFiles) {
+    $pdfPath = [System.IO.Path]::ChangeExtension($file.FullName, ".pdf")
+    Write-Host "Compiling $($file.FullName) to $pdfPath"
+
+    asciidoctor-pdf "$($file.FullName)" -r asciidoctor-diagram -a pdf-theme="$themePath" -a allow-uri-read=true -a source-highlighter=rouge -o "$pdfPath" --trace
+}

scripts/Setup_helper_asciidoc.ps1

@@ -0,0 +1,44 @@
+# Ensure Ruby is installed
+if (-not (Get-Command "ruby" -ErrorAction SilentlyContinue)) {
+    Write-Error "Ruby is not installed. Please install Ruby first."
+    exit 1
+
+
+# Ensure asciidoctor-pdf is installed
+if (-not (Get-Command "asciidoctor-pdf" -ErrorAction SilentlyContinue)) {
+    Write-Host "Installing asciidoctor-pdf gem..."
+    & gem install asciidoctor-pdf | Out-Host
+    # Wait for the installation to complete before proceeding
+    if (-not (Get-Command "asciidoctor-pdf" -ErrorAction SilentlyContinue)) {
+        Write-Error "asciidoctor-pdf installation failed."
+        exit 1
+    }
+}
+
+# Ensure asciidoctor-diagram is installed
+if (-not (gem list asciidoctor-diagram -i | Select-String "true")) {
+    Write-Host "Installing asciidoctor-diagram gem..."
+    & gem install asciidoctor-diagram | Out-Host
+    # Wait for the installation to complete before proceeding
+    if (-not (gem list asciidoctor-diagram -i | Select-String "true")) {
+        Write-Error "asciidoctor-diagram installation failed."
+        exit 1
+    }
+}
+
+# Ensure ImageMagick is installed for prawn-gmagick to work
+if (-not (Get-Command "magick" -ErrorAction SilentlyContinue)) {
+    Write-Host "ImageMagick is not installed. Please install ImageMagick (https://imagemagick.org/script/download.php) and ensure 'magick' is in your PATH."
+}
+
+# Ensure prawn-gmagick is installed for image format support
+if (-not (gem list prawn-gmagick -i | Select-String "true")) {
+    Write-Host "Installing prawn-gmagick gem for image format support..."
+    & gem install prawn-gmagick | Out-Host
+}
+
+# Ensure rouge is installed for syntax highlighting
+if (-not (gem list rouge -i | Select-String "true")) {
+    Write-Host "Installing rouge gem for syntax highlighting..."
+    & gem install rouge | Out-Host
+}

src/Avalonia.Samples/CompleteApps/SimpleToDoList/README.adoc

@@ -2,11 +2,14 @@
 // --- D O N ' T    T O U C H   T H I S    S E C T I O N ---
 :toc:
 :toc-placement!:
+
+ifdef::env-github[]
 :tip-caption: :bulb:
 :note-caption: :information_source:
 :important-caption: :heavy_exclamation_mark:
 :caution-caption: :fire:
 :warning-caption: :warning:
+endif::[]
 // ----------------------------------------------------------