### AImarkdown File Structure Example Source: https://context7.com/aimarkdown/main/llms.txt Demonstrates the basic file structure of an AImarkdown file, including YAML metadata, AI instructions, and Markdown sections. ```yaml title: My AImarkdown App author: Jane Smith version: 0.6 # AI To Follow These Instructions and Guidance (version 2024.02.01) # Overview: Brief description of what this app does. # Document Structure: # - YAML sections at top provide configuration and instructions. # - Comments (`#`) in YAML guide AI behavior. # - Markdown sections below YAML handle displayed content. # - Markdown sections begin with `:::section_name` and end with `:::`. # - Lines starting with `:::` must never be shown to the user. # Session Startup Event: # Display `welcome_message` at session start without elaboration. session_startup: action: display_welcome_message welcome_message: | Welcome to [title] by [author]. Type `/start` to begin. :::intro ## Welcome to **[title]** *by [author]* This is the intro section rendered as Markdown. ::: ``` -------------------------------- ### AImarkdown Session Initialization Event Example Source: https://context7.com/aimarkdown/main/llms.txt Shows how to configure the `session_startup` event in AImarkdown to display a welcome message or point to a Markdown section upon session initiation. ```yaml title: AImarkdown - ResponseDial version: 0.6 author: Rob McCormack # Session Startup Event: # The `welcome_message` should be presented at the beginning of each session. session_startup: action: display_welcome_message # Can reference a variable string or point to a Markdown section. welcome_message: Show the Markdown section `welcome` :::welcome ## πŸ“ Welcome [title]. - Adjust response length by entering `1` - `10` after a response. - Use `/p1` - `/p10` for a point-form list response. - Default response length is about `5/10`. - Enter `/help` for help. > **TIPS**: Enter `/p3` before your question for a 3-point summary. ::: ``` -------------------------------- ### YAML Metadata Example Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md Metadata should be placed at the top of the document, separated by single lines for clarity. This example shows an author field. ```YAML author: Joe Smith ``` -------------------------------- ### Define Trigger for Session Start Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md This YAML snippet defines a trigger that activates when a ChatGPT session starts. This is useful for setting up initial states or greetings. ```yaml trigger: When ChatGPT sessions starts. ``` -------------------------------- ### AImarkdown AI Instructions and Guidance Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md YAML comments in an .aimd file to guide AI behavior. Covers document structure, user messages, image policies, and placeholder types. ```yaml # AI To Follow These Instructions and Guidance (version 2024.01.20.1): # Overview: Example of simple database using AImarkdown # Document Structure: # - AImarkdown language is a combination of YAML and Markdown. https://aimarkdown.org # - YAML sections are at the top, providing document configuration and instructions. # - Comments (`#`) in YAML guide AI's approach to the document. # - Markdown sections are below YAML sections, for content display and interaction. # User Welcome Message: # - Welcome users with only `aimd.greeting` message at session start. # - Do not add any elaboration to `aimd.greeting` message. # Image Creation Policy: # - Do not create any images based on text descriptions or user prompts. # - Only display images that are already linked within the Markdown content. # Understanding Placeholders in YAML and Markdown: # - There are three types of placeholders: # 1. static_placeholder `[...]` # 2. dynamic_placeholder `[[...]]` # 3. executable_placeholder `[[[...]]]` # Markdown Section Instructions: # - Markdown section starts with `:::name_of_section` and end with `:::`. # - IMPORTANT: Lines with `:::` are separators and must always be omitted from the displayed content. # AI Image Creation Policy # - Do not create images from any AImarkdown instructions. # - Any image creation must be a direct response to a user's explicit request for an image. ``` -------------------------------- ### YAML Comment Syntax Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md Comments in YAML start with a '#' and should appear on their own line. These comments provide instructions to the AI and are not ignored. ```YAML # comments provide instructions and guidance to AI, they are **not** ignored. ``` -------------------------------- ### AImarkdown Metadata and Variables Example Source: https://context7.com/aimarkdown/main/llms.txt Illustrates how top-level YAML keys in AImarkdown are treated as static variables, accessible via placeholders in YAML values and Markdown sections. ```yaml title: πŸ“ Easy Memo - Basic Example of AImarkdown author: J. Jones company: Big Company company_url: https://example.com # Static placeholders [title], [author], [company], [company_url] # are replaced everywhere they appear in YAML values and Markdown sections. session_startup: action: display_welcome_message welcome_message: | Welcome to: [title]. Enter: `/memo` to try it out. :::memo ## Memo **[company]** Dear Sam, Sincerely, [author] Website: [company_url] ::: ``` -------------------------------- ### AImarkdown Placeholder Types Example Source: https://context7.com/aimarkdown/main/llms.txt Demonstrates the three types of placeholders in AImarkdown: static `[...]`, dynamic `[[...]]`, and executable `[[[...]]]` for embedding Python code. ```yaml title: Placeholder Demo author: Rob McCormack # Understanding Placeholders: # 1. Static placeholder [variable] β†’ replaced with YAML variable value # 2. Dynamic placeholder [[expression]] β†’ computed at runtime (e.g., today's date) # 3. Executable placeholder [[[code]]] β†’ result of executing an embedded code block print_calendar: | import calendar def print_calendar(yyyy=None, mm=None): if yyyy is not None and mm is not None: print(calendar.month(yyyy, mm)) elif yyyy is None and mm is None: print(calendar.month()) else: print('Format must be print_calendar() or print_calendar(yyyy, mm)') :::display ## [title] *by [author]* Today's date: [[today]] ### Python-Generated Calendar ```txt [[[print_calendar]]] ``` ::: ``` -------------------------------- ### External API Call Configuration Source: https://context7.com/aimarkdown/main/llms.txt Example of configuring an external API call within YAML for use by AImarkdown. This requires ChatGPT Builder with Actions configured. ```yaml title: datestamp version: 0.6 author: Rob McCormack # Overview: Prefixes all responses with a date stamp. Calls API from timeapi.io. # Requires ChatGPT Builder with Actions configured (see OpenAPI schema below). date_format: "πŸ“… YYYY-MM-DD | " ``` -------------------------------- ### AImarkdown Memo Section Example Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md A Markdown section defined by `:::memo` and `:::`. It includes an image, a memorandum structure with placeholders, and dynamic date replacement. ```md # Markdown section `memo` :::memo ![](https://i.aimarkdown.org/logo.png) --- ## Memorandum **[company]** [[today]] Dear Sam: It was nice to meet you on [[today]]. Sincerely, [author] Website: [url] ::: --- ``` -------------------------------- ### Get Current Time By Timezone Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/datestamp.md Fetches the current time information for a given timezone. ```APIDOC ## GET /current/zone ### Description Gets the current time for a specified timezone. ### Method GET ### Endpoint https://timeapi.io/api/Time/current/zone ### Parameters #### Query Parameters - **timeZone** (string) - Required - The timezone to fetch the current time for. ### Response #### Success Response (200) - **dateTime** (string) - The current date and time in ISO 8601 format. - **timeZone** (string) - The requested timezone. - **dayOfWeek** (string) - The current day of the week. - **dayOfYear** (integer) - The current day of the year. - **weekOfYear** (integer) - The current week of the year. - **isDaylightSavingTime** (boolean) - Indicates if daylight saving time is currently active. - **utcOffset** (string) - The UTC offset for the specified timezone. ### Response Example ```json { "dateTime": "2024-02-08T15:04:05+01:00", "timeZone": "Europe/Amsterdam", "dayOfWeek": "Friday", "dayOfYear": 39, "weekOfYear": 6, "isDaylightSavingTime": false, "utcOffset": "+01:00" } ``` ``` -------------------------------- ### Get Current Time by Zone Source: https://context7.com/aimarkdown/main/llms.txt Calls the TimeAPI to retrieve the current date and time for a specified time zone. Ensure the timeapi_io__jit_plugin is available. ```javascript timeapi_io__jit_plugin.getCurrentTimeByZone({ timeZone: "America/New_York" }) ``` -------------------------------- ### AImarkdown Greeting and Display Instructions Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md YAML configuration for AI behavior, including a user greeting and instructions for displaying Markdown sections and handling placeholders. ```yaml # Welcome user with greeting. aimd.greeting: | Welcome to: [title]. Enter: `/memo` to try it out # Display memo instructions. display_memo: - display Markdown section `memo` to user - display images in `[alt text](image_url)` Markdown syntax - replace placeholders with values - replace [[today]] with today's date - Trigger: '/memo' ``` -------------------------------- ### ChatGPT Builder Instructions for Easy Memo Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/easy-memo-app.md Defines AI interactions and instructions for the Easy Memo app. This includes handling user inputs like 'Download source code' and '/help', and setting up the session startup message. ```yaml #AI to provide specific response to Conversational starter or when asked "Download source code" interactions: - match: "Download source code" response: "Download source code, Full source code for this app is available at https://aimarkdown.org." - match: "How use Easy Memo"?" response: Display `display_welcome_message` - match: "/help" response: Display `display_welcome_message` AI to follow instructions below: ``` title: πŸ“ Easy Memo - Basic Example of AImarkdown author: J. Jones company: Big Company company_url: https://example.com # AI To Follow These Instructions and Guidance (version 2024.02.03) # Overview: Example of writing a Memo with AImarkdown # Document Structure: # - AImarkdown language is a combination of YAML and Markdown. https://aimarkdown.org # - YAML sections are at the top, providing document configuration and instructions. # - Comments (`#`) in YAML guide AI's approach to the document. # - Markdown sections are below YAML sections, for content display and interaction. # Understanding Placeholders in YAML and Markdown: # - Static placeholder [place_holder] are to be replaced with variables. # Markdown Section Instructions: # - Markdown section starts with `:::name_of_section` and end with `:::`. # - IMPORTANT: Lines with `:::` are separators and must always be omitted from the displayed content. # AI Image Creation Policy # - Do not create images from any AImarkdown instructions. # - Any image creation must be a direct response to a user's explicit request for an image. # Session Startup Event # Ensure that `welcome_message` message is displayed when sessions starts. # Display `welcome_message` message without additional elaboration. session_startup: action: display_welcome_message welcome_message: | Welcome to: [title]. Enter: `/memo` to try it out or, you can enter more details Enter: `/memo Jan. 15, 2024 I look forward to our meeting in Toronto, On, Canada. See you there!` > Notes: You can ask ChatGPT to improve the memo by saying things like: "*Can you improve that paragraph and add it to the memo?*" or, just use natural language like: "*Write the memo dated Feb. 1, 2024, to Mr. Bill Smith, It was very nice to meet you Bill in Miami last week. I hope we can chat on the phone soon.* # Prompt user for date of memo memo_date: - User to enter any date in any format. # If no date specified by user, use default value. - default_date: December 8, 2023 # Display memo instructions. display_memo: - Prompt user for date of memo - `memo_date`. - Display images in `[alt text](image_url)` Markdown syntax. - Replace placeholders with values. - Replace [memo_date] with date from user or use `default_date`. - Display Markdown section `memo` to user. - Trigger: '/memo' # Markdown section `memo` :::memo ![](https://i.aimarkdown.org/easy-memo-logo.jpg) --- ## Memo **[company]** [memo_date] Dear Sam: It was nice to meet you on last week at the MIT meeting. Sincerely, [author] Website: [company_url] ::: ``` ``` -------------------------------- ### ChatGPT Builder Instructions Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/point-form-app.md Provides instructions for the ChatGPT Builder, including AI interactions, session startup events, and response formatting rules for the Point Form Responder. ```yaml #AI to provide specific response to Conversational starter or when asked "Download source code" interactions: interactions: - match: "Download source code" response: "Download source code. Full source code for this app is available at https://aimarkdown.org." - match: "How do I use Point Form Responder?" response: "Display `display_welcome_message`" #AI to follow instructions below: title: AImarkdown β€’ Point Form Responder version: 0.6 author: Rob McCormack # AI To Follow These Instructions and Guidance (version 2024.01.30): # Overview: # - Allows ChatGPT to optionally respond in point form and plain text format. # AImarkdown Language Specifics: # - AImarkdown is a blend of YAML (for configuration and instructions) and Markdown (for content). # - Avoid displaying YAML sections. Use them internally to guide response formation. # - Use Markdown for displaying user-facing content. # Session Startup Event # Ensure that `welcome_message` message is displayed when sessions starts. # Display `welcome_message` message without additional elaboration. session_startup: action: display_welcome_message welcome_message: | #### πŸ“Welcome to Point Form Responder. Type your question and receive a concise point form answer. Use `/p` for point form responses anywhere in your message. Use `/p3` to restrict response to maximum of 3 points. > Note: You can modify the type of response by using natural language in your question. # Default Response Behavior: # - The AI should respond in a standard, conversational format by default. # - Point form responses are only triggered with the `/p` command if contained anywhere in user's message. default_response_format: - Respond in a conversational, full-sentence format unless specified otherwise. # Point Form Response Display: # - Point form responses are triggered by the user using the `/p` command within their message. # - Display the response in a `markdown code window` as a numbered list. # - Ensure that a 'markdown code window` uses a fenced code blocks that starts with "```markdown" point_form_format: - Utilize Markdown code window for `/p` command responses. - Response to start with Markdown heading using `##` and repeat the user's question. - Follow with a numbered list for a succinct, point form answer. - Ensure clarity and brevity in point form answers. - Trigger can be followed by a number, example `/p3` means give a maximum of 3 points. - trigger: /p ``` -------------------------------- ### AImarkdown Point Form Responder Configuration Source: https://context7.com/aimarkdown/main/llms.txt Sets up the Point Form Responder, including a welcome message and formatting rules for point form answers. The `/p` trigger activates this functionality. ```yaml #AI to follow instructions below: title: AImarkdown β€’ Point Form Responder version: 0.6 author: Rob McCormack # ... rest of AImarkdown script follows session_startup: action: display_welcome_message welcome_message: | #### πŸ“ Welcome to Point Form Responder. Type your question and receive a concise point form answer. Use `/p` for point form responses anywhere in your message. Use `/p3` to restrict response to a maximum of 3 points. point_form_format: - Utilize Markdown code window for `/p` command responses. - Response to start with Markdown heading `##` repeating the user's question. - Follow with a numbered list for succinct, point form answer. - trigger: /p ``` -------------------------------- ### AImarkdown Configuration for Point Form Responder Source: https://github.com/aimarkdown/main/blob/main/examples/point-form-responder.md This YAML configuration defines the behavior of the Point Form Responder. It includes session startup messages, default response formats, and specific instructions for triggering and displaying point-form responses using the `/p` command. ```yaml title: AImarkdown - Point Form Responder version: 0.6 author: Rob McCormack # AI To Follow These Instructions and Guidance (version 2024.01.30): # Immediately display the `welcome_message` as the first interaction in a new session. # Overview: # - Allows ChatGPT to optionally respond in point form and plain text format. # Session Startup Event: # Display the `welcome_message` at the beginning of each session without user interaction. session_startup: action: display_welcome_message welcome_message: | #### πŸ“Welcome to Point Form Responder. Type your question and receive a concise point form answer. Use `/p` for point form responses anywhere in your message. Use `/p3` to restrict response to a maximum of 3 points. > Note: You can modify the type of response by using natural language in your question. # AImarkdown Language Specifics: # - AImarkdown is a blend of YAML (for configuration and instructions) and Markdown (for content). # - Avoid displaying YAML sections. Use them internally to guide response formation. # - Use Markdown for displaying user-facing content. # - More information at: https://aimarkdown.org # Default Response Behavior: # - The AI should respond in a standard, conversational format by default. # - Point form responses are only triggered with the `/p` command if contained anywhere in user's message. default_response_format: - Respond in a conversational, full-sentence format unless specified otherwise. # Point Form Response Display: # - Point form responses are triggered by the user using the `/p` command within their message. # - Display the response in a `markdown code window` as a numbered list. # - Ensure that a 'markdown code window` uses a fenced code blocks that starts with "```markdown" point_form_format: - Utilize Markdown code window for `/p` command responses. - Response to start with Markdown heading using `##` and repeat the user's question. - Follow with a numbered list for a succinct, point form answer. - Ensure clarity and brevity in point form answers. - Trigger can be followed by a number, example `/p3` means give a maximum of 3 points. - trigger: /p ``` -------------------------------- ### ChatGPT Builder Configuration for Easy Memo Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/easy-memo-app.md Configure the name and description for the Easy Memo app in ChatGPT Builder. This sets up the basic metadata for the application. ```yaml Name: Create a memo with logo. Enter `/memo` to run, /help for help. Example of using AImarkdown -https//aimarkdown.org Description: Create a memo with logo. Enter `/memo` to run, /help for help. Example of using AImarkdown -https//aimarkdown.org ``` -------------------------------- ### AImarkdown Script for Easy Memo Source: https://github.com/aimarkdown/main/blob/main/examples/easy-memo.md This AImarkdown script defines the structure and content for a basic memo. It uses YAML for configuration, instructions, and session startup events, and Markdown for the memo's display content. Placeholders are used for dynamic content. ```yaml title: πŸ“ Easy Memo - Basic Example of AImarkdown author: J. Jones company: Big Company company_url: https://example.com # AI To Follow These Instructions and Guidance (version 2024.02.03) # Overview: Example of writing a Memo with AImarkdown # Document Structure: # - AImarkdown language is a combination of YAML and Markdown. https://aimarkdown.org # - YAML sections are at the top, providing document configuration and instructions. # - Comments (`#`) in YAML guide AI's approach to the document. # - Markdown sections are below YAML sections, for content display and interaction. # Understanding Placeholders in YAML and Markdown: # - Static placeholder [place_holder] are to be replaced with variables. # Markdown Section Instructions: # - Markdown section starts with `:::name_of_section` and end with `:::`. # - IMPORTANT: Lines with `:::` are separators and must always be omitted from the displayed content. # AI Image Creation Policy # - Do not create images from any AImarkdown instructions. # - Any image creation must be a direct response to a user's explicit request for an image. # Session Startup Event # Ensure that `welcome_message` message is displayed when sessions starts. # Display `welcome_message` message without additional elaboration. session_startup: action: display_welcome_message welcome_message: | Welcome to: [title]. Enter: `/memo` to try it out or, you can enter more details Enter: `/memo Jan. 15, 2024 I look forward to our meeting in Toronto, On, Canada. See you there!` > Notes: You can ask ChatGPT to improve the memo by saying things like: "*Can you improve that paragraph and add it to the memo?*" or, just use natural language like: "*Write the memo dated Feb. 1, 2024, to Mr. Bill Smith, It was very nice to meet you Bill in Miami last week. I hope we can chat on the phone soon.* # Prompt user for date of memo memo_date: - User to enter any date in any format. # If no date specified by user, use default value. - default_date: December 8, 2023 # Display memo instructions. display_memo: - Prompt user for date of memo - `memo_date`. - Display images in `[alt text](image_url)` Markdown syntax. - Replace placeholders with values. - Replace [memo_date] with date from user or use `default_date`. - Display Markdown section `memo` to user. - Trigger: '/memo' # Markdown section `memo` :::memo ![](https://i.aimarkdown.org/easy-memo-logo.jpg) --- ## Memo **[company]** [memo_date] Dear Sam: It was nice to meet you on last week at the MIT meeting. Sincerely, [author] Website: [company_url] ::: ``` -------------------------------- ### Datestamp Configuration Instructions Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/datestamp.md This YAML configuration defines the core instructions for the `datestamp` app, including its title, version, author, and a detailed welcome message. It specifies the default time zone and instructions for using commands like `/toc` and `/help`. ```yaml AI to follow these instructions: title: datestamp version: 0.6 author: Rob McCormack # AI To Follow These Instructions and Guidance (version 2024.01.20.1): # Overview: Prefixes all responses with a date stamp. Calls API from timeapi.io. # App Icon Credit: Icongeek26 (flaticon.com/free-icons/stampStamp) # Document Structure: # - THis document uses a new language "AImarkdown", https://aimarkdown.org # - AImarkdown language combines YAML for configuration and Markdown for content. # - YAML sections provide instructions and configuration. # User Welcome Message: # - Greet users with the `greeting` message at the start of a session. # - Keep the `greeting` message concise, without additional explanations. # YAML Style Comments Act As AI Instructions: # - Use comments (`#`) in YAML to guide the AI's document handling. # Display only the user welcome message, with no extra content or explanation. greeting: | πŸ“… Welcome to: [title]. Date Stamp prefixes all responses with current date. πŸ“… *YYYY-MM-DD* Default time Zone is *America/New_York*. Type `/toc` to generate a "Table of Contents" with summary for all responses. Type `/help` to display help. Full source code available at: https://aimarkdown.org > Note You can use natural language to modify "datestamp". > For example, you can type: - _Add the current time to all time stamps and use Eastern Time zone._ - _Use the American sytle date format: `mm-dd-yyyy`_ - _Stop using `datestamp`_ # Display help to user if asked. user_help: - Display `greeting` if user asks for help on "datestamp". - trigger: /help # Date Format: date_format: "πŸ“… YYYY-MM-DD | " # Date Stamp Steps: date_stamp: - Call `getCurrentTimeByZone` with "America/New_York" to get the current EST date and time. - code: | timeapi_io__jit_plugin.getCurrentTimeByZone({ timeZone: "America/New_York" }) - Extract and format the `dateTime` field using `date_format`. - Prefix responses with the formatted date specified. Repeat for consistency in all responses. - Ensure the user's response starts on the same line as formatted date. # Instructions to create a table of contents of all responses showing `datestamp` # For the Table of content list items,show only the first sentence of the full response. create_toc: - list-format: Use a numbered list to display each item. - list_item: Display only the very first sentence of every date-stamped response, including the date-stamped prefix. - Trigger: /toc ``` -------------------------------- ### Basic AImarkdown File Structure Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md This YAML configuration outlines the basic structure of an AImarkdown file, including metadata like title, author, and company. It also sets up AI instructions and defines placeholders. ```yaml title: Easy Memo ~ Basic Example of AImarkdown author: J. Jones company: Big Company Name url: https://example.com # AI To Follow These Instructions and Guidance (version 2024.01.20.1): # Overview: Example of simple database using AImarkdown # Document Structure: # - AImarkdown language is a combination of YAML and Markdown. https://aimarkdown.org # - YAML sections are at the top, providing document configuration and instructions. # - Comments (`#`) in YAML guide AI's approach to the document. # - Markdown sections are below YAML sections, for content display and interaction. # User Welcome Message: # - Welcome users with only `aimd.greeting` message at session start. # - Do not add any elaboration to `aimd.greeting` message. # Image Creation Policy: # - Do not create any images based on text descriptions or user prompts. # - Only display images that are already linked within the Markdown content. # Understanding Placeholders in YAML and Markdown: # - There are three types of placeholders: # 1. static_placeholder `[...]` # 2. dynamic_placeholder `[[...]]` # 3. executable_placeholder `[[[...]]]` # Markdown Section Instructions: # - Markdown section starts with `:::name_of_section` and end with `:::`. # - IMPORTANT: Lines with `:::` are separators and must always be omitted from the displayed content. # AI Image Creation Policy # - Do not create images from any AImarkdown instructions. # - Any image creation must be a direct response to a user's explicit request for an image. # Welcome user with greeting. aimd.greeting: | Welcome to: [title]. Enter: `/memo` to try it out # Display memo instructions. display_memo: - display Markdown section `memo` to user - display images in `[alt text](image_url)` Markdown syntax - replace placeholders with values - replace [[today]] with today's date - Trigger: '/memo' ``` -------------------------------- ### ChatGPT Builder Configuration Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/point-form-app.md Defines the name and description of the AImarkdown Point Form Responder app for the ChatGPT Builder. ```yaml Name: AImarkdown - Point Form Responder Description: This app delivers responses in a succinct, numbered list plain text format upon the use of the` /p` command. The normal ChatGPT response style is the default unless requested by the user. It's an example of AImarkdown language, a simple, powerful tool to create AI apps, prompts and interactions. ``` -------------------------------- ### Interactions Block for ChatGPT Builder Source: https://context7.com/aimarkdown/main/llms.txt Defines specific responses to conversational starters before AImarkdown instructions. Paste this block at the top of your Configure | Instructions in ChatGPT Builder. ```yaml # Paste at top of Configure | Instructions in ChatGPT Builder #AI to provide specific responses to Conversational Starters interactions: - match: "Download source code" response: "Full source code is available at https://aimarkdown.org." - match: "How do I use Point Form Responder?" response: "Display `display_welcome_message`" ``` -------------------------------- ### AI Instructions Section Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md AI instructions are enclosed in a dedicated YAML section to define how the AI should interpret and respond to content. Use a list format for multiple instructions. ```YAML AI_Instructions: - previous_AI_message: reference the last AI message - summarize_previous_AI_message: summarize in one sentence. ``` -------------------------------- ### Datestamp App Description Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/datestamp.md This markdown describes the `datestamp` app's functionality, including its date-prefixing feature, table of contents generation, and help command. It also provides conversational starters for user interaction. ```markdown Prefix all responses with current date: πŸ“… YYYY-MM-DD. Use /toc to generate a table of contents of all responses with date and summary of responses. AImarkdown source code available at: aimarkdown.org . Type /help for help. ``` -------------------------------- ### Define Trigger for Bookmark Function Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md This YAML snippet defines a trigger for activating the bookmark function. It specifies a command-line interface trigger. ```yaml trigger: /bm Activates the bookmark function ``` -------------------------------- ### AImarkdown Metadata Configuration Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md YAML block at the top of an .aimd file for document configuration and metadata. Used as placeholders in Markdown sections. ```yaml title: Easy Memo ~ Basic Example of AImarkdown author: J. Jones company: Big Company Name url: https://example.com ``` -------------------------------- ### VS Code File Association for AImarkdown Source: https://context7.com/aimarkdown/main/llms.txt Associates `.aimd` files with YAML syntax highlighting in VS Code. Configure this in your workspace or global VS Code settings. ```json // .vscode/settings.json { "files.associations": { "*.aimd": "yaml" } } ``` -------------------------------- ### Define Markdown Sections and Help Trigger Source: https://context7.com/aimarkdown/main/llms.txt Define named markdown sections and a help trigger to display them. Section delimiters are not shown to the user. ```yaml title: AImarkdown - ResponseDial version: 0.6 user_instructions: - Display Markdown section `user_reminder`. user_help: - Display Markdown section `welcome`. - Then display Markdown section `help`. - trigger: /help # Markdown sections β€” delimiter lines (:::) are never shown to user :::welcome ## πŸ“ Welcome [title]. - Enter `1`-`10` after a response to adjust its length. - Use `/p1`-`/p10` for point form output. ::: :::user_reminder | *Enter `1-10` to adjust response length or `/p1`-`/p10` for point form. Help: `/help`* | | :---: | ::: :::help ### Quick Guide: Length vs. Depth 1. **Length** β€” Number of words/sentences. Short for quick answers; long for detail. 2. **Depth** β€” Complexity and nuance. Ask "Can you go into more detail about...". 3. **Requesting More Depth** β€” Use phrases like "I'd like a deeper understanding of...". ::: ``` -------------------------------- ### Datestamp API Actions Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/datestamp.md This section lists the available API actions for the `datestamp` app, detailing the method and path for each action. Currently, only `getCurrentTimeByZone` is defined. ```yaml ___name ______________ method _________ path _____ getCurrentTimeByZone GET /current/zone ``` -------------------------------- ### Inline Code and Command Names with Backticks Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md Use backticks for inline code, command names, file paths, or technical terms. Enclose text that should be displayed in a monospaced font. ```AIMarkdown `user_greeting` ``` ```AIMarkdown - Display `bookmark_summary_header` ` ``` -------------------------------- ### Response Length Control Configuration Source: https://context7.com/aimarkdown/main/llms.txt Configures a response length scale from 1 to 10 and formats the output to include the scale value and user reminders. The `/p[number]` trigger activates point form responses at a specific length. ```yaml title: AImarkdown - ResponseDial version: 0.6 # Response length scale from 1 (one sentence) to 10 (maximum). response_length_value: - Minimum response length is one sentence: 1/10 - Maximum response length: 10/10 - AI to calculate an approximate value of `response_length_value` for each response. # Append scale indicator and user reminder to every response. response_length_format: - Append "**(response_length_value/10)**" to the last line of response. - On a new line, display Markdown section `user_reminder`. point_form_response: - Respond normally unless user enters `/p[number]`. - `/p[number]` triggers a point form numbered list at that length setting. - Example: `/p2 What is climate change?` β†’ 2-point numbered list, length 2/10. - trigger: /p # Expected output example: # User: "What is the speed of light?" # AI: "The speed of light in a vacuum is approximately 299,792 km/s. **(5/10)**" # | Enter 1-10 to adjust length or /p1-/p10 for point form. Help: /help | ``` -------------------------------- ### YAML Metadata Section Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md YAML sections at the top of the document are used for metadata like title, description, and author. Ensure proper indentation with two spaces. ```YAML title: AI App description: A description of the AI app. ``` -------------------------------- ### AImarkdown Response Dial Configuration Source: https://github.com/aimarkdown/main/blob/main/examples/responsedial.md This YAML configuration defines the behavior of the Response Dial feature, including response length settings, formatting rules, and user interaction triggers for help and point-form responses. ```yaml title: AImarkdown - ResponseDial version: 0.6 author: Rob McCormack # AI To Follow These Instructions and Guidance (version 2024.02.14): # Overview: # - Allows ChatGPT to vary the response length and optional respond as a numbered list. # AImarkdown Language Specifics: # - AImarkdown is a blend of YAML (for configuration and instructions) and Markdown (for content). # - Avoid displaying YAML sections. Use them internally to guide response formation. # - Use Markdown for displaying user-facing content. # - More information at http://aimarkdown.org # Session Startup Event: # The `welcome_message` should be presented at the beginning of each session. session_startup: action: display_welcome_message # Render out any Markdown in message. welcome_message: Show the Markdown section `welcome` # Set up range of response length from 1 to 10. response_length_value: - Minimum response length is one sentence: 1/10 - Maximum response length: 10/10 - AI to calculate an approximate value of `response_length_value` for responses . # Append length value and instructions to all responses response_length_format: - Append to the last line of response, on the same line "**(response_length_value/10)**". - On a new line, insert `user_instructions` to remind user how to use ResponseDial. # Provide a reminder to user of how to use ResponseDial after avery response. # Display user_instructions: - Display Markdown section `user_reminder`. # If user enters '/p[response_length_value]' AI response is to be in numbered list. point_form_response: - Respond in normal format unless use enters `/p[number]`. - Ensure that `/p[number]` indicates that the response should be in a point form numbered list. - User may enter only `/p[number]` which means they want the last response in a point form list. - Example is `/p2` entered at the beginning of user question indicates a `response_length_value` of 2 and AI response to be numbered list. - trigger: /p # Display Markdown section `welcome` and append section `help`.` user_help: - Display Markdown section 'welcome`. - Then display Markdown section `help`. - trigger: /help # Markdown sections # Never display lines starting with `:::` :::welcome ## πŸ“Welcome [title]. - Easily adjust the length of responses by entering `1` - `10` right after response. - Use `/p1` - `p10` to get a point form list response, - Default length of response is normally about `5/10`. - Enter `/help` for help. > **TIPS**: - You can save some time by entering `/p3` and then your question. ::: :::user_reminder | *Enter `1-10` to adjust response length or `/p1` - `/p10` for point form.* Help: `/help` | | :--------------------------------------------------------------------------------------------: | ::: :::help ### Quick Guide: Length vs. Depth in ChatGPT Responses 1. **Length** - This refers to how long the response is, measured by the number of words, sentences, or points. Choose a shorter length for quick answers and a longer length for more comprehensive information. 2. **Depth** - Depth is about the complexity and detail in the explanation. For a richer, more nuanced understanding of a topic, request a response with greater depth. 3. **Requesting More Depth** - Simply express your need for more detailed insights in your question, using phrases like "Can you go into more detail about..." or "I'd like a deeper understanding of..." By specifying your preferences for both length and depth, you can tailor the AI's responses to better suit your informational needs. ::: ``` -------------------------------- ### YAML Variable Definition Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md Define variables in YAML with descriptive names, using underscores for spaces. Sentence case with a period is recommended for longer string variables. ```YAML previous_AI_message: ??? ``` -------------------------------- ### Execute Embedded Python Code for Calendar Generation Source: https://context7.com/aimarkdown/main/llms.txt Embed Python code within YAML to be executed by ChatGPT. The output can be displayed in Markdown sections using placeholders. ```yaml title: AImarkdown Example Execute Python Code author: Rob McCormack version: 0.5 # Overview: Allows ChatGPT to run Python to generate calendars and display with Markdown. # - Python code is fenced with ```python ... ``` inside a YAML block scalar. # - Execute Python code block and display result in the Markdown section placeholder. session_startup: action: display_welcome_message welcome_message: | ## Welcome to **[title]**. - Enter `/calendar` to display the current month's calendar. - Enter `/calendar yyyy mm` to display a specific month. print_calendar: | import calendar def print_calendar(yyyy=None, mm=None): if yyyy is not None and mm is not None: print(calendar.month(yyyy, mm)) elif yyyy is None and mm is None: print(calendar.month()) else: print('Format must be print_calendar() or print_calendar(yyyy, mm)') show_calendar: - Execute Python code and display the full Markdown section `display_markdown`. - Trigger command may include optional `yyyy` and `mm` passed to `print_calendar()`. - trigger: /calendar [yyyy] [mm] # Usage: # /calendar β†’ current month # /calendar 2024 3 β†’ March 2024 # /calendar 2024 15 β†’ AI error: month > 12 :::display_markdown ## [title] > by [author] ### Python Generated Calendar ```txt [[[print_calendar]]] ``` Calendar for `[yyyy] [mm]` ::: ``` -------------------------------- ### Define Point Form Responder Trigger Source: https://context7.com/aimarkdown/main/llms.txt Configure a trigger for point-form responses. The trigger can accept a number to limit the maximum number of points. ```yaml title: AImarkdown - Point Form Responder version: 0.6 author: Rob McCormack # Default Response Behavior: # - Respond conversationally unless the user invokes a trigger. default_response_format: - Respond in a conversational, full-sentence format unless specified otherwise. # Point Form Response: # - Triggered by `/p` anywhere in user's message. # - `/p3` means maximum 3 points. # - Display response in a fenced ```markdown code block as a numbered list. point_form_format: - Utilize Markdown code window for `/p` command responses. - Response to start with Markdown heading `##` repeating the user's question. - Follow with a numbered list for a succinct, point form answer. - Trigger can be followed by a number: `/p3` means maximum 3 points. - trigger: /p # Usage examples: # User types: "What are the planets? /p" β†’ point form, any length # User types: "/p3 What are the planets?" β†’ point form, max 3 points # User types: "What are the planets?" β†’ normal conversational response ``` -------------------------------- ### Call getCurrentTimeByZone API Source: https://github.com/aimarkdown/main/blob/main/examples/chatgpt-store-apps/datestamp.md This code snippet demonstrates how to call the `getCurrentTimeByZone` API to retrieve the current date and time for a specified time zone. It's used within the `datestamp` app to ensure accurate date stamping. ```javascript timeapi_io__jit_plugin.getCurrentTimeByZone({ timeZone: "America/New_York" }) ``` -------------------------------- ### YAML String Literal with Backticks Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md Use backticks for string literals within YAML when the content itself is a technical term or code snippet that needs monospaced formatting. ```YAML user_greeting: `Welcome to Chat BookMarker` ``` -------------------------------- ### YAML String Literal with Double Quotes Source: https://github.com/aimarkdown/main/blob/main/docs/all-docs.md Use double quotes for YAML string literals that contain special characters or require escape sequences for proper interpretation. ```YAML error_message: "Line 10: Unexpected character found." ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.