Skip to content

GUIDE_FORMATS.md

Latest commit

 

History

History
137 lines (102 loc) · 3.33 KB

GUIDE_FORMATS.md

File metadata and controls

137 lines (102 loc) · 3.33 KB

Guide Format Versions

This package includes the complete guide in multiple formats for your convenience.

Available Formats

1. GUIDE.md (Markdown)

  • Raw markdown format
  • Best for: Reading in text editors, version control, GitHub
  • View in: Any text editor, GitHub, VS Code, etc.

2. GUIDE.html (HTML)

  • Fully formatted with styling
  • Best for: Web browsers, printing to PDF from browser, sharing
  • Features: Table of contents, syntax highlighting, responsive design
  • Open in: Any web browser
  • Print to PDF: Use browser's Print function (Ctrl+P or Cmd+P)

3. GUIDE.pdf (PDF)

  • High-quality formatted document
  • Best for: Distribution, offline reading, printing
  • Create with: See instructions below

How to Generate PDF

Option 1: Using R (Recommended)

Ensure you have the required R packages:

# Install required packages (one time)
install.packages("rmarkdown")
tinytex::install_tinytex()  # This installs a lightweight LaTeX distribution

Then generate the PDF:

# In R console, from the shinyModals directory
source("create_guide_pdf.R")

This will create GUIDE.pdf in the current directory.

Option 2: Browser Print to PDF (Easiest)

  1. Open GUIDE.html in your web browser
  2. Press Ctrl+P (Windows/Linux) or Cmd+P (Mac)
  3. Select "Save as PDF" as the printer
  4. Click "Save"
  5. Name it GUIDE.pdf

Advantages:

  • No additional software needed
  • Works on any computer
  • Output is professional looking
  • Takes 30 seconds

Option 3: Using Pandoc

If you have Pandoc installed:

pandoc GUIDE.md -o GUIDE.pdf --pdf-engine=xelatex

Or with more styling options:

pandoc GUIDE.md -o GUIDE.pdf \
  --pdf-engine=xelatex \
  --toc \
  --number-sections \
  --highlight-style=tango \
  -V geometry:margin=1in

Troubleshooting

"rmarkdown package not found"

install.packages("rmarkdown")

"tinytex not installed"

install.packages("tinytex")
tinytex::install_tinytex()

"xelatex not found"

This means LaTeX is not installed. Install one of:

PDF looks wrong

  • Use Option 2 (Browser print) - it usually works best
  • Make sure you're using a modern browser (Chrome, Firefox, Safari, Edge)
  • Try printing with "Background graphics" enabled

File Descriptions

File Format Size Best For
GUIDE.md Markdown ~30 KB Development, version control
GUIDE.html HTML ~80 KB Web browser, sharing, print to PDF
GUIDE.pdf PDF ~200 KB Distribution, printing, offline reading

Recommendations

  • For reading: Use GUIDE.html (nicest formatting)
  • For sharing: Use GUIDE.html or GUIDE.pdf
  • For printing: Use GUIDE.html (print to PDF from browser)
  • For version control: Use GUIDE.md
  • For archiving: Use GUIDE.pdf

Quick Start (Option 2 - Browser Print)

# 1. Open in browser
open GUIDE.html          # Mac
start GUIDE.html         # Windows
xdg-open GUIDE.html      # Linux

# 2. Press Ctrl+P (or Cmd+P)
# 3. Select "Save as PDF"
# 4. Click Save

# Done! You have GUIDE.pdf

Updated: December 10, 2025
shinyModals Version: 0.4.0