### Start Aitoearn Preview Server Source: https://docs.aitoearn.ai/quickstart Navigate to your documentation directory and start the local development server. This allows you to preview changes in real-time. ```bash mint dev ``` -------------------------------- ### Install Aitoearn CLI Source: https://docs.aitoearn.ai/quickstart Install the Aitoearn CLI globally using npm. This command is necessary to run the local preview server. ```bash npm i -g mint ``` -------------------------------- ### OpenAPI Configuration Examples Source: https://docs.aitoearn.ai/essentials/settings Configure OpenAPI specifications using absolute URLs, relative paths, or an array for multiple sources. ```json "openapi": "https://example.com/openapi.json" ``` ```json "openapi": "/openapi.json" ``` ```json "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] ``` -------------------------------- ### Run Local Development Server on Custom Port Source: https://docs.aitoearn.ai/development Start a local development server on a custom port using the --port flag. If the specified port is in use, Aitoearn will use the next available port. ```bash mint dev --port 3333 ``` -------------------------------- ### Footer Socials Configuration Example Source: https://docs.aitoearn.ai/essentials/settings Define social media links for the footer by mapping platform keys to their respective URLs. ```json { "x": "https://x.com/aitoearn", "website": "https://aitoearn.com" } ``` -------------------------------- ### Markdown Example with Embedded Java Code Block Source: https://docs.aitoearn.ai/essentials/code Demonstrates how a Markdown fenced code block can contain another code block, here showing a Java example with syntax highlighting. ```markdown ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` ``` -------------------------------- ### Import and use a basic reusable snippet Source: https://docs.aitoearn.ai/essentials/reusable-snippets Import a snippet from the `/snippets` directory into your destination file and use it like a component, passing any necessary props. ```mdx --- title: My title description: My Description --- import MySnippet from '/snippets/path/to/my-snippet.mdx'; ## Header Lorem impsum dolor sit amet. ``` -------------------------------- ### Force Light Mode Source: https://docs.aitoearn.ai/essentials/settings Configure the documentation to always display in light mode by setting the default to 'light' and hiding the toggle. ```json "modeToggle": { "default": "light", "isHidden": true } ``` -------------------------------- ### Create a basic reusable snippet Source: https://docs.aitoearn.ai/essentials/reusable-snippets Add content to a file in the `snippets` directory. This content can include variables that can be filled in via props when the snippet is imported. ```mdx Hello world! This is my content I want to reuse across pages. My keyword of the day is {word}. ``` -------------------------------- ### Update Site Configuration Source: https://docs.aitoearn.ai/quickstart Modify the 'docs.json' file to change your site's name and colors. These changes are reflected instantly in the local preview. ```json { "name": "your project name", "colors": { "primary": "#yourBrandColor" } } ``` -------------------------------- ### Import and use a reusable component snippet Source: https://docs.aitoearn.ai/essentials/reusable-snippets Import a component snippet into your destination file and render it, passing any required props to customize its content. ```mdx --- title: My title description: My Description --- import { MyComponent } from '/snippets/custom-component.mdx'; Lorem ipsum dolor sit amet. ``` -------------------------------- ### Navigation with Folder Structure Source: https://docs.aitoearn.ai/essentials/navigation Shows how to reference pages located within folders. The path in `docs.json` should reflect the folder structure, e.g., `your-folder/your-page`. ```json "navigation": { "tabs": [ { "tab": "Docs", "groups": [ { "group": "Group Name", "pages": ["your-folder/your-page"] } ] } ] } ``` -------------------------------- ### Force Dark Mode Source: https://docs.aitoearn.ai/essentials/settings Configure the documentation to always display in dark mode by setting the default to 'dark' and hiding the toggle. ```json "modeToggle": { "default": "dark", "isHidden": true } ``` -------------------------------- ### Troubleshoot 'sharp' Module Error Source: https://docs.aitoearn.ai/development Resolve the 'Error: Could not load the "sharp" module' by uninstalling and reinstalling the CLI after upgrading Node.js. ```bash npm remove -g mint npm i -g mint ``` -------------------------------- ### Markdown Link Source: https://docs.aitoearn.ai/essentials/markdown Create links by wrapping text in square brackets and the URL in parentheses. ```markdown [link to google](https://google.com) ``` -------------------------------- ### Validate Documentation Links Source: https://docs.aitoearn.ai/development Check your documentation for broken links using the 'mint broken-links' command. ```bash mint broken-links ``` -------------------------------- ### Update Aitoearn CLI Source: https://docs.aitoearn.ai/development Update the Aitoearn CLI to the latest version. This is recommended if your local preview does not align with the production version. ```bash npm mint update ``` -------------------------------- ### Markdown Image Syntax Source: https://docs.aitoearn.ai/essentials/images Use Markdown syntax to add images. Ensure image file size is less than 5MB or host on a service like Cloudinary or S3. ```md ![title](/path/image.jpg) ``` -------------------------------- ### Java Code Block with Syntax Highlighting Source: https://docs.aitoearn.ai/essentials/code Enclose Java code in triple backticks, specifying 'java' for syntax highlighting. Optionally, include a filename like 'HelloWorld.java'. ```java class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` -------------------------------- ### LaTeX Component Source: https://docs.aitoearn.ai/essentials/markdown Render LaTeX equations using the `` component. ```markdown 8 x (vk x H1 - H2) = (0,1) ``` -------------------------------- ### Regular Navigation Structure Source: https://docs.aitoearn.ai/essentials/navigation Defines a basic navigation structure with tabs and groups. Use this for simple, non-nested navigation layouts. ```json "navigation": { "tabs": [ { "tab": "Docs", "groups": [ { "group": "Getting Started", "pages": ["quickstart"] } ] } ] } ``` -------------------------------- ### Nested Navigation Structure Source: https://docs.aitoearn.ai/essentials/navigation Illustrates how to create nested navigation groups for hierarchical organization. This is useful for structuring complex documentation with multiple levels of sub-pages. ```json "navigation": { "tabs": [ { "tab": "Docs", "groups": [ { "group": "Getting Started", "pages": [ "quickstart", { "group": "Nested Reference Pages", "pages": ["nested-reference-page"] } ] } ] } ] } ``` -------------------------------- ### Create a reusable component snippet Source: https://docs.aitoearn.ai/essentials/reusable-snippets Export an arrow function component from a snippet file. This component can accept props and be used in other files. ```mdx export const MyComponent = ({ title }) => (

{title}

... snippet content ...

); ``` -------------------------------- ### Import and use exported variables Source: https://docs.aitoearn.ai/essentials/reusable-snippets Import exported variables from a snippet file into your destination file and use them to populate content dynamically. ```mdx --- title: My title description: My Description --- import { myName, myObject } from '/snippets/path/to/custom-variables.mdx'; Hello, my name is {myName} and I like {myObject.fruit}. ``` -------------------------------- ### Export variables from a snippet file Source: https://docs.aitoearn.ai/essentials/reusable-snippets Export variables from a snippet file to make them available for import in other files. This allows for dynamic content insertion. ```mdx export const myName = 'my name'; export const myObject = { fruit: 'strawberries' }; ``` -------------------------------- ### Display Inline Code in Markdown Source: https://docs.aitoearn.ai/essentials/code Use single backticks to format words or phrases as inline code. This is useful for highlighting variable names, keywords, or short commands within a sentence. ```markdown To denote a `word` or `phrase` as code, enclose it in backticks (`). ``` -------------------------------- ### Markdown Subtitle Source: https://docs.aitoearn.ai/essentials/markdown Use triple hash symbols for subsection headers in Markdown. ```markdown ### Subtitles ``` -------------------------------- ### Markdown Strikethrough Text Source: https://docs.aitoearn.ai/essentials/markdown Format text with a strikethrough using double tildes. ```markdown ~strikethrough~ ``` -------------------------------- ### Markdown Multiline Blockquote Source: https://docs.aitoearn.ai/essentials/markdown Create a multiline blockquote by prefixing each line with a greater-than symbol and using blank lines between paragraphs. ```markdown > Dorothy followed her through many of the beautiful rooms in her castle. > > The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. ``` -------------------------------- ### Markdown Single-line Blockquote Source: https://docs.aitoearn.ai/essentials/markdown Create a single-line blockquote by prefixing the text with a greater-than symbol. ```markdown > Dorothy followed her through many of the beautiful rooms in her castle. ``` -------------------------------- ### Markdown Bold and Italic Text Source: https://docs.aitoearn.ai/essentials/markdown Combine bold and italic formatting using double asterisks and single underscores. ```markdown **_bold and italic_** ``` -------------------------------- ### HTML Image Embed Source: https://docs.aitoearn.ai/essentials/images Use HTML img tags for more customizable image embedding. This allows for attributes like height and source specification. ```html ``` -------------------------------- ### HTML Superscript Text Source: https://docs.aitoearn.ai/essentials/markdown Use the `` HTML tag for superscript text. ```html superscript ``` -------------------------------- ### Markdown Title Source: https://docs.aitoearn.ai/essentials/markdown Use double hash symbols for section titles in Markdown. ```markdown ## Titles ``` -------------------------------- ### Markdown Bold Text Source: https://docs.aitoearn.ai/essentials/markdown Format text as bold using double asterisks. ```markdown **bold** ``` -------------------------------- ### Markdown Italic Text Source: https://docs.aitoearn.ai/essentials/markdown Format text as italic using single underscores. ```markdown _italic_ ``` -------------------------------- ### HTML iFrame Embed for Videos Source: https://docs.aitoearn.ai/essentials/images Embed external content, such as YouTube videos, using HTML iframe tags. This provides a flexible way to include rich media. ```html ``` -------------------------------- ### HTML Subscript Text Source: https://docs.aitoearn.ai/essentials/markdown Use the `` HTML tag for subscript text. ```html subscript ``` -------------------------------- ### OpenAPI Security Scheme: Bearer Token Source: https://docs.aitoearn.ai/api-reference/introduction This JSON snippet defines the security scheme for API endpoints, specifying Bearer token authentication. It's typically found within an OpenAPI specification file. ```json "security": [ { "bearerAuth": [] } ] ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.