Reference: Export

Overview

This documents the output formats available in the export documentation command.

File System

The file system export format (--format fs). This format will output documentation to a file system in the folder structure shown below:

output-path/ # The path specified by --output
  source1/ # separate directories for each source
    /path/to/document1.md # 1 file for each document exported for a source
    /path/to/document2.md
  source2
    /path/to/document3.md
    ...
  README.md # Metadata about the export

llms-full.txt

The llms-full.txt export format (--format llmsfulltxt). This format will output documentation to the output path as a text file using the structure shown below:

# <Title> (Name of first section, or document ID if none found)
Source: <Document URI> (document://<source>/<document>)

<Document Contents>


# <Title>
...

Note: The documentation is sorted by source ID ascending, document ID ascending

JSON

The JSON export format (--format json). This format will output documentation to the output path as a JSON file using the structure shown below:

[
  {
    "source": "<source ID>",
    "document": "<document ID>",
    "uri": "document://<source>/<document>",
    "purpose": "", // omitted if blank
    "content": "",
    "tags": [ // Empty array if no tags
      {"key":"foo", "value":"bar"},
      ....
    ],
  },
  ...
]

Note: The output is sorted by source ID ascending, document ID ascending

SQLite

The SQLite export format (--format sqlite). This format will export documentation to an SQLite database in the same format as the input documentation. Please see Documentation Data Set for the schema.