Documentation

Export as Markdown

You can export your documentation as a Markdown file directly from the documentation page. Look for the export icon next to the filter options. Clicking this icon will initiate the export process.

The export process may take a few seconds depending on the size of your documentation. Once completed, the Markdown file (.md) will be downloaded directly to your device.

Purpose and Use Cases

Exporting your documentation as Markdown serves several valuable purposes:

  • Backup and Posterity: Having a local copy of your documentation ensures that you have a backup for your records and for long-term preservation.
  • LLM Integration: The Markdown format is highly compatible with Large Language Models (LLMs). You can easily feed your exported documentation into LLMs for various use cases, such as:
    • Generating summaries or overviews of your application's documentation.
    • Asking questions about specific data types, workflows, or pages.
    • Identifying potential inconsistencies or areas for improvement in your documentation.
    • Creating training data for fine-tuning custom LLMs for your project.
    • Automating the generation of reports or summaries based on your documentation.
  • Offline Access: Access your documentation even without an internet connection.

This feature provides flexibility and control over your documentation, allowing you to leverage it in ways that best suit your workflow and needs.

Need further assistance? .