Markdown -> Slides Walkthrough

​

Summary (TLDR)

• Purpose:
  Generate slide decks by providing Markdown strings—each representing the exact content and structure of a single slide. This feature lets you focus on what to say without the hassle of styling or slide generation.
• Key Benefit:
  The exact Markdown you supply (including headings, nested lists, links, etc.) is rendered directly onto brand-compliant, custom layout slides. The API abstracts away the complexities of interacting with PPTX or Google Slides, so you can concentrate on content.
• Important Note on Parameters:
  When using the outline parameter, if you supply a number_slides value, it must equal the length of the outline list. Additionally, for each outline item, you may only provide either the markdown attribute or a combination of layout_instruction and/or content_instruction. If markdown is provided, all other instructions for that slide are ignored.

​

Use Cases

• Exact Content Rendering:
  Directly insert your prepared Markdown content into slides. The system handles all the intricacies of slide generation so that your text appears exactly as written.
• Brand Consistency Without the Hassle:
  Maintain your custom fonts, styles, and layouts effortlessly. The API abstracts away the detailed work of styling and text placement, letting you focus solely on content.
• Streamlined Workflow:
  Save time by not having to interact with PPTX or Google Slides documents manually. The API automatically maps your Markdown to the proper slide format and design.
• Seamless LLM Integration:
  Markdown is the natural output type for many large language models (LLMs). This feature is built to seamlessly integrate with any LLM, allowing you to directly use the Markdown generated by an LLM as input for your FlashDocs API call.

​

Quick Start Example

curl --request POST \
  --url https://api.flashdocs.ai/v3/generate/deck \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prompt": "In a few slides, describe the recent innovations in renewable energy. Discuss key research findings, case studies, market impact, and future outlooks.",
  "source_document_id": "abc-def-ghi-jkl",
  "outline": [
    {
      "markdown": "## Renewable Energy Overview\n\n### Key Sources\n- **Solar Energy**: Derived from sunlight. [Learn more](https://example.com/solar).\n- **Wind Energy**: Captured through wind turbines.\n- **Geothermal Energy**: Heat extracted from the earth.\n\n### Importance\nRenewable energy plays a crucial role in:\n1. **Reducing greenhouse gas emissions**\n2. Enhancing energy security\n3. Fostering economic growth\n\n> Note: The adoption of renewable energy is accelerating globally."
    },
    {
      "markdown": "### Research & Innovations\n\n#### Technological Advances\n- **Solar Panel Efficiency**:\n  - Advanced materials and coatings\n  - Multi-junction cells\n- **Wind Turbine Design**:\n  - Improved blade aerodynamics\n  - Enhanced control systems\n\n#### Research Highlights\nRecent breakthroughs include:\n1. A major breakthrough in energy storage technology.\n2. [Global Research Collaboration](https://example.com/research-collaboration) enhancing climate impact studies.\n\n> *Innovation is the key to a sustainable future.*"
    },
    {
      "markdown": "### Case Study\n\n#### Project Overview\n- **Location**: Germany\n- **Focus**: Urban solar integration\n\n#### Implementation Details\n  - **Architecture Integration**:\n    - Rooftop installations\n    - Facade panels\n  - **Community Impact**:\n    - Lowered energy costs\n    - Increased local awareness\n\n#### Outcomes\n1. Significant reduction in CO2 emissions.\n2. Enhanced urban aesthetics.\n3. [Full Project Report](https://example.com/germany-case-study)\n\n> This case study exemplifies the innovative blend of design and functionality."
    },
    {
      "markdown": "### Market Impact\n\n#### Economic Shifts\n- **Investment Trends**:\n  - Surge in green bonds\n  - Increased venture capital in cleantech\n- **Job Creation**:\n  - Direct jobs in installation and maintenance\n  - Indirect opportunities in tech and finance sectors\n\n#### Global Reach\n- **Emerging Markets**:\n  - Rapid growth in Asia and Africa\n- **Established Economies**:\n  - Transitioning from fossil fuels\n\n#### Future Outlook\n1. Increased government incentives.\n2. Robust growth forecasts.\n3. [Market Analysis Report](https://example.com/market-impact)\n\n> The renewable market is a dynamic blend of technology, policy, and finance."
    },
    {
      "layout_instruction": "Closing slide with thank you note.",
      "content_instruction": "Conclude with future outlooks in renewable energy."
    }
  ],
  "audience_domain": "slack.com"
}'

• The outline array contains five items, matching the number_slides value of 5.
• Each outline item uses the markdown attribute exclusively. For these slides, the provided Markdown is the exact content inserted—all other prompt or layout instructions are ignored.

​

Markdown to Slide Mapping

1. Parsing Markdown into an AST:
   The API begins by parsing each Markdown string into an Abstract Syntax Tree (AST). This tree captures the hierarchical structure of the content, including headings, lists, links, and nested elements.
2. Creating Slide Layout Trees:
   For each slide in your library, a tree structure is generated that represents the slide’s layout. This structure defines text placeholders based on your custom design, determined with the help of an advanced custom LLM.
3. Mapping via Graph Algorithms:
   We employ advanced graph algorithms—specifically, subgraph isomorphism—to find an optimal mapping from the Markdown AST to the text placeholders on each slide. This ensures that the structure of your content is seamlessly aligned with the available placeholders.
4. Optimal Slide Layout Selection:
   Based on the mapping, our system selects the best slide layout for the content. This decision ensures that the design and structure of the slide perfectly accommodate the Markdown content.
5. Direct Markdown Insertion:
   When an outline item includes the markdown attribute, the mapped Markdown content is inserted directly into the chosen slide. In this mode, all other prompt or layout instructions for that slide are disregarded, guaranteeing that the slide displays exactly the content you provided.

​

Conclusion