Skip to content

Sitemap

A semantic map of all documentation pages for Engrapha, helping both users and AI agents navigate the codebase tools.

Home

  • Home - Generate beautiful PDFs, notes, diagrams, slides, and flashcards from Python or Markdown.

Getting Started

  • Getting Started - Engrapha lets you produce themed academic PDFs, vector diagrams, and flashcards with just a few lines of Python.
  • Why Engrapha? - Several tools can help you produce diagrams or notes. Engrapha's value is combining all of them into one Python toolkit with vector-native graphics,...

Notes

  • Notes: Basics - This page covers the core API of engrapha_notes: themes, headings, body, and footers. By the end of this page you'll be able to construct a struct...
  • Notes: Callouts and Highlights - Engrapha ships with semantic callout blocks for all the most common exam-note situations.
  • Notes: Study and Revision Helpers - Engrapha ships several blocks specifically for preparation: question, qbox, mcq, revision card, and flashcard.
  • Notes: Advanced - Advanced ingredients you will need for full-length textbooks, lab reports, and research notes.
  • Notes: Templates - Engrapha ships built-in helpers for common document types. Each returns a ready-to-use NotesTheme, so you do not have to configure fonts, colors, ...
  • Notes: Export Formats - Once your story is assembled, Engrapha can emit PDF, HTML, PPTX, and Anki packages.

Diagrams

  • Diagrams: Overview - Engrapha ships with 13 vector-native diagram types. This page helps you pick the right one.
  • Diagram: Flowchart - Draw ANSI/ISO flowchart symbols: terminals (pills), rectangles, decisions (diamonds), I/O (parallelograms), connectors (circles), and predefined-proce...
  • Diagram: Sequence - A UML sequence diagram maps ordered message arrows over lifelines. Each actor is placed left-to-right at the top. A dashed lifeline drops down. Activa...
  • Diagrams: ER and Schema - This page covers ERDiagram (Chen notation -professional- style) and SchemaDiagram (plain database table with FK lines).
  • Diagram: Schema - Schema diagrams display database table structures: columns, data types, primary key and foreign key markers, plus labelled relationship arcs.
  • Diagram: Class (UML) - UML class diagrams express OOP structure: classes with stereotypes, attributes, methods, and six relationship types.
  • Diagram: State Machine - State machines are suitable for DFAs, process states, and life-cycle flows. States are circles (double-circles for accepting states). Transitions are ...
  • Diagram: Network - Network topology diagrams render hosts, switches, routers, clouds, firewalls, databases, wireless points, and more. Presets for bus, star, ring,...
  • Diagrams: Architecture, C4, and AWS - Three closely related diagram types: ArchitectureDiagram, C4ContainerDiagram, and AWSDiagram. All share the same auto-layout engine and orthogon...
  • Diagram: C4 Container - C4 Container diagrams document software systems and their containers (web apps, databases, APIs) with descriptive relationships.
  • Diagram: AWS Cloud - AWS diagrams render vector-native AWS resource icons on top of the standard ArchitectureDiagram layout. All auto-layout and orthogonal routing from `A...
  • Diagram: Layered Stack - LayeredStack draws horizontal layers and dividers. Ideal for OSI/TCP-IP stacks, memory hierarchies, and any stacked software structure.
  • Diagram: Timing - Timing diagrams render digital waveforms side-by-side, perfect for busses, SPI, I2C, and memory timing.
  • Diagram: Git - Git diagrams visualize branches, commits, and merge commits on horizontal or vertical timelines.
  • Gallery - Screenshots and examples for each diagram type and theme combination. Screenshots will be added later; placeholder markers are in place.
  • Gallery: Flowcharts - Flowcharts are the most frequently used diagram type in Engrapha. This page shows standard variations.
  • Gallery: ER Diagrams - ER and Schema diagrams built with the Chen and SQL table notations.
  • Gallery: Sequence Diagrams - Sequence diagrams express API calls, handshake protocols, and event ordering.
  • Gallery: Network Diagrams - Network topology examples: simple LAN, bus topology, star, mesh, and tree.
  • Gallery: Architecture Diagrams - System architecture and cloud topology examples.
  • Gallery: Themes - The same diagram rendered in every preset Engrapha theme. This page shows the power and clean auto-matching of the theme system.
  • Gallery: Notes Pages - Full page screenshots of notes documents generated by Engrapha. Each entry shows a representative document-type alongside the Python that generates ...

Examples

  • Example: Engineering Notes - A complete engineering-notes session using Engrapha.
  • Example: Resume - A single-page resume using Engrapha's section blocks, bullet lists, and timeline blocks.
  • Example: Assignment - Assignment sheet with question numbers, code blocks, marking rubrics, and MCQs.
  • Example: Thesis Chapter - Academic chapter with sections, citations, formulas, index entries, and an embedded diagram.
  • Example: Networking Notes - Networking notes using OSI-layer stacks, packet header diagrams, and sequence diagrams to show the stack holistically.

API Reference

Themes

  • Themes - Engrapha comes with 10 preset themes for engrapha_diagrams and 15 preset themes for engrapha_notes.

Markdown

  • Markdown Compiler - Engrapha ships with a CLI tool that compiles standard Markdown files into themed PDFs. Two commands, engrapha and pdfnotes, are installed by t...

Changelog

Contributing

  • Contributing - Thank you for considering contributing to Engrapha! This page explains how to set up a development environment, run tests, and submit changes.

Sitemap

  • Sitemap - A semantic map of all documentation pages for Engrapha, helping both users and AI agents navigate the codebase tools.

For a structured index optimized for LLMs, see llms.txt.