Skip to content

USAGE.md

Latest commit

 

History

History
158 lines (125 loc) · 2.97 KB

USAGE.md

File metadata and controls

158 lines (125 loc) · 2.97 KB

Quick Start Guide

Setup

  1. Install dependencies:
npm install
  1. Build the project:
npm run build
  1. Configure Claude Desktop (or your MCP client):
{
  "mcpServers": {
    "beamer": {
      "command": "node",
      "args": ["/path/to/Beamer-MCP/dist/index.js"]
    }
  }
}

Quick Example

Ask Claude to create a presentation:

Create a 5-slide presentation about artificial intelligence with the Madrid theme.
Include sections for Introduction, History, Applications, Challenges, and Future.
Save it as "ai-presentation" and compile to PDF.

Claude will:

  1. Use create_presentation to set up the document
  2. Use add_section and add_slide to build the content
  3. Use save_document to create the .tex file
  4. Use compile_latex to generate the PDF

Common Workflows

Simple Presentation

User: Create a presentation about Python with 3 slides covering basics, features, and use cases.

Research Poster

User: Create an A0 portrait research poster about climate change with sections for
Abstract, Methods, Results, and Conclusions.

Custom Theme

User: Create a presentation with the Copenhagen theme and dolphin color scheme about data science.

With Images

User: Create a presentation with a slide showing the image at ./charts/results.png

LaTeX Tips

Mathematical Equations

$E = mc^2$

$$\int_{0}^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2}$$

Lists

\begin{itemize}
  \item First item
  \item Second item
\end{itemize}

\begin{enumerate}
  \item Numbered item
  \item Another item
\end{enumerate}

Code Blocks

\begin{verbatim}
def hello():
    print("Hello, World!")
\end{verbatim}

Highlighting

\textbf{Bold text}
\textit{Italic text}
\alert{Highlighted text}

Advanced Features

Custom Blocks

\begin{block}{Title}
Content here
\end{block}

\begin{alertblock}{Warning}
Important information
\end{alertblock}

\begin{exampleblock}{Example}
Example content
\end{exampleblock}

Overlays (Incremental Reveals)

\begin{frame}{Progressive Disclosure}
\begin{itemize}
  \item<1-> First appears
  \item<2-> Second appears
  \item<3-> Third appears
\end{itemize}
\end{frame}

TikZ Graphics

\begin{tikzpicture}
  \draw (0,0) circle (1cm);
  \draw[->] (0,0) -- (1,1);
\end{tikzpicture}

Output Files

After compilation, you'll find:

  • filename.tex - LaTeX source
  • filename.pdf - Final PDF
  • filename.aux, filename.log, etc. - Auxiliary files

Troubleshooting

Problem: "pdflatex not found" Solution: Install a LaTeX distribution (TeX Live, MiKTeX)

Problem: Missing LaTeX packages Solution: Install with your package manager or use full TeX Live installation

Problem: Images not appearing Solution: Use absolute paths or ensure images are in the working directory

Problem: Unicode characters not displaying Solution: Add \usepackage[utf8]{inputenc} to preamble