The /markdown Command

Instructions for Using the /markdown Command

The /markdown command allows you to export chat responses from the assistant to a Markdown file. This feature is especially useful for saving important responses, insights, or conversations for later reference in a structured format.

Command Format

/markdown [offset] [folder_alias]

• offset (optional): Specifies which model response to save, where 0 is the most recent response, 1 is the second-most recent, and so on. If not provided, the default is 0.

• folder_alias (optional): The alias representing the folder where you want to save the Markdown file. If not provided, the file will be saved to a default folder specified in the configuration.

How It Works

1. Exports the specified model response (based on the offset) to a Markdown file.

2. The file is saved in the folder associated with the provided alias.

3. If the alias is not provided, it uses the default save path from your configuration.

4. Notifies you when the file is successfully saved or if an error occurs.

Examples

1. Saving the Most Recent Model Response:

   /markdown 0

   • This saves the latest response to the default folder.

2. Saving a Response with a Specific Offset:

   /markdown 2

   • This saves the third-most recent model response (offset 2) to the default folder.

3. Saving to a Specific Folder Using an Alias:

   /markdown 0 reports

   • This saves the most recent response in the folder associated with the alias reports.

4. Combining Offset and Folder Alias:

   /markdown 1 logs

   • This saves the second-most recent response in the folder associated with the alias logs.

File Naming

• Files are saved with the format:

  llm_response_YYYYMMDD_HHMMSS_offset_X.md

• Example:

  llm_response_20241117_134512_offset_0.md

• This timestamp-based naming ensures that files do not overwrite each other.

Setting Up Folder Aliases

Before using /markdown with a folder alias, make sure to set up your alias using the /setalias command:

/setalias reports ~/documents/reports

• After setting the alias, you can use it directly with the /markdown command.

Error Handling

• Invalid Offset: If the offset is out of range, you will receive a notification:

  Invalid offset. There are only [X] model responses.

• Folder Not Found: If the alias does not exist or is not set correctly, you'll see:

  Error: Folder alias 'reports' not found.

• Markdown File Creation Error: If the file cannot be created due to a permission issue or other errors:

  Error saving response to Markdown: [error details]

Pro Tips

• Quick Exports: Use /markdown 0 frequently to save the latest responses for quick documentation.

• Organize Responses: Set up multiple folder aliases for different projects using /setalias to keep your Markdown files organized.

• Review Responses: The exported Markdown files include structured headers for easy reading and navigation.

By using the /markdown command, you can effortlessly document your chat interactions, ensuring important insights are preserved for future reference.