@md-plugins/quasar-app-extension-q-press 0.1.0-alpha.10

package/src/templates/init/src/_q-press/api/components/MarkdownApiEntry.json

@@ -0,0 +1,76 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-api-entry"
+  },
+  "functions": {
+    "getProp": {
+      "desc": "Function to get a property node for the API entry.",
+      "params": {
+        "openState": {
+          "type": "Object",
+          "desc": "The state object to manage open/close state of nodes."
+        },
+        "masterKey": {
+          "type": "String",
+          "desc": "The master key for the API entry."
+        },
+        "prop": {
+          "type": "Object",
+          "desc": "The property object to generate the node for."
+        },
+        "paramName": {
+          "type": "String",
+          "desc": "The name of the parameter."
+        },
+        "level": {
+          "type": "Number",
+          "desc": "The level of the property in the hierarchy."
+        }
+      },
+      "returns": {
+        "type": "Array<VNode>",
+        "desc": "An array of VNode elements representing the property."
+      }
+    },
+    "getDiv": {
+      "desc": "Function to create a div element for the API entry.",
+      "params": {
+        "cols": {
+          "type": "Number",
+          "desc": "The number of columns the div should span."
+        },
+        "label": {
+          "type": "String",
+          "desc": "The label for the div."
+        },
+        "key": {
+          "type": "String",
+          "desc": "The key for the div."
+        },
+        "children": {
+          "type": "Array<VNode>",
+          "desc": "The child nodes for the div."
+        }
+      },
+      "returns": {
+        "type": "VNode",
+        "desc": "A VNode element representing the div."
+      }
+    },
+    "getStringType": {
+      "desc": "Function to get the string representation of a type.",
+      "params": {
+        "type": {
+          "type": "Object",
+          "desc": "The type object to get the string representation for."
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "The string representation of the type."
+      }
+    }
+  },
+  "types": {}
+}

package/src/templates/init/src/_q-press/api/components/MarkdownCardLink.json

@@ -0,0 +1,28 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-card-link"
+  },
+  "props": {
+    "to": {
+      "type": "String",
+      "desc": "The target URL or path for the link",
+      "examples": [
+        "/home",
+        "https://example.com"
+      ],
+      "required": true,
+      "category": "navigation"
+    },
+    "external": {
+      "type": "Boolean",
+      "desc": "Flag to indicate if the link is external",
+      "category": "navigation"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot for custom content inside the link"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownCardTitle.json

@@ -0,0 +1,48 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-card-title"
+  },
+  "props": {
+    "title": {
+      "type": "String",
+      "desc": "The title text to display",
+      "examples": [
+        "'Introduction'",
+        "'Chapter 1'"
+      ],
+      "category": "content"
+    },
+    "prefix": {
+      "type": "String",
+      "desc": "Prefix to add to the slugified title",
+      "examples": [
+        "'section-'"
+      ],
+      "category": "content"
+    }
+  },
+  "events": {
+    "click": {
+      "desc": "Emitted when the title is clicked",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  },
+  "methods": {
+    "onClick": {
+      "desc": "Handler for the click event on the title",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      },
+      "returns": null
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownCode.json

@@ -0,0 +1,37 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-code"
+  },
+  "props": {
+    "code": {
+      "type": "String",
+      "desc": "The code to display",
+      "examples": [
+        "'const a = 1;'",
+        "'<div>Hello World</div>'"
+      ],
+      "category": "content"
+    },
+    "maxHeight": {
+      "type": "String",
+      "desc": "Maximum height for the code block",
+      "examples": [
+        "'200px'",
+        "'50vh'"
+      ],
+      "category": "style"
+    },
+    "lang": {
+      "type": "String",
+      "desc": "Language of the code for syntax highlighting",
+      "default": "js",
+      "examples": [
+        "'js'",
+        "'html'",
+        "'css'"
+      ],
+      "category": "content"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownCodePrism.json

@@ -0,0 +1,29 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-code-prism"
+  },
+  "props": {
+    "code": {
+      "type": "String",
+      "desc": "The code to display with syntax highlighting",
+      "examples": [
+        "'const a = 1;'",
+        "'<div>Hello World</div>'"
+      ],
+      "required": true,
+      "category": "content"
+    },
+    "lang": {
+      "type": "String",
+      "desc": "Language of the code for syntax highlighting",
+      "examples": [
+        "'js'",
+        "'html'",
+        "'css'"
+      ],
+      "required": true,
+      "category": "content"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownCodepen.json

@@ -0,0 +1,21 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-codepen"
+  },
+  "props": {
+    "active": {
+      "type": "Boolean",
+      "desc": "Flag to indicate if the form should be active",
+      "category": "state"
+    },
+    "options": {
+      "type": "String",
+      "desc": "JSON string containing the CodePen options",
+      "examples": [
+        "'{\"title\":\"My Pen\",\"html\":\"<div>Hello World</div>\"}'"
+      ],
+      "category": "content"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownCopyButton.json

@@ -0,0 +1,36 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-copy-button"
+  },
+  "props": {
+    "lang": {
+      "type": "String",
+      "desc": "Language of the code block to copy",
+      "examples": [
+        "'js'",
+        "'html'",
+        "'css'"
+      ],
+      "category": "content"
+    }
+  },
+  "events": {
+    "copy": {
+      "desc": "Emitted when the copy button is clicked",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  },
+  "methods": {
+    "copy": {
+      "desc": "Method to copy the code block to the clipboard",
+      "params": {},
+      "returns": null
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownDrawerSidebar.json

@@ -0,0 +1,17 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-drawer-toc"
+  },
+  "events": {
+    "toggleTocDrawer": {
+      "desc": "Emitted when the close button is clicked to toggle the Table of Contents drawer",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownDrawerToc.json

@@ -0,0 +1,17 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-drawer-toc"
+  },
+  "events": {
+    "toggleTocDrawer": {
+      "desc": "Emitted when the close button is clicked to toggle the Table of Contents drawer",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownExample.json

@@ -0,0 +1,22 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-example"
+  },
+  "props": {
+    "title": {
+      "type": "String",
+      "desc": "Title of the example",
+      "examples": [
+        "'Example 1'",
+        "'Sample Code'"
+      ],
+      "category": "content"
+    },
+    "noGithub": {
+      "type": "Boolean",
+      "desc": "Flag to indicate if the GitHub button should be hidden",
+      "category": "behavior"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownHeader.json

@@ -0,0 +1,28 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-header"
+  },
+  "props": {
+    "heightHint": {
+      "type": "Number",
+      "desc": "Height hint for the header",
+      "examples": [
+        128,
+        64
+      ],
+      "category": "style"
+    }
+  },
+  "events": {
+    "toggleMenuDrawer": {
+      "desc": "Emitted when the menu button is clicked to toggle the menu drawer",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownHeaderIconLinks.json

@@ -0,0 +1,16 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-header-icon-links"
+  },
+  "props": {
+    "menu": {
+      "type": "Array",
+      "desc": "Array of menu entries to display as icon links in the header",
+      "examples": [
+        "[{ icon: 'home', path: '/' }, { icon: 'info', path: '/about' }]"
+      ],
+      "category": "content"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownHeaderMenu.json

@@ -0,0 +1,77 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-header-menu"
+  },
+  "props": {
+    "elements": {
+      "type": "Array",
+      "desc": "Array of menu elements to display in the header menu",
+      "examples": [
+        "[{ name: 'Home', path: '/' }, { name: 'Docs', path: '/docs' }]"
+      ],
+      "category": "content"
+    },
+    "mqPrefix": {
+      "type": "String",
+      "desc": "Prefix for media query classes",
+      "examples": [
+        "'md'",
+        "'lg'"
+      ],
+      "category": "style"
+    }
+  },
+  "types": {
+    "MenuElement": {
+      "desc": "Interface representing a menu element.",
+      "properties": {
+        "header": {
+          "type": "String",
+          "desc": "Header text for the menu element."
+        },
+        "separator": {
+          "type": "Boolean",
+          "desc": "Flag to indicate if the element is a separator."
+        },
+        "path": {
+          "type": "String",
+          "desc": "Path for the menu element."
+        },
+        "external": {
+          "type": "Boolean",
+          "desc": "Flag to indicate if the path is external."
+        },
+        "icon": {
+          "type": "String",
+          "desc": "Icon name for the menu element."
+        },
+        "name": {
+          "type": "String",
+          "desc": "Name of the menu element."
+        },
+        "mq": {
+          "type": "String",
+          "desc": "Media query for the menu element."
+        },
+        "children": {
+          "type": "Array<MenuElement>",
+          "desc": "Array of child menu elements."
+        }
+      }
+    },
+    "Props": {
+      "desc": "Interface representing the props for the component.",
+      "properties": {
+        "elements": {
+          "type": "Array<MenuElement>",
+          "desc": "Array of menu elements to display in the header menu."
+        },
+        "mqPrefix": {
+          "type": "String",
+          "desc": "Prefix for media query classes."
+        }
+      }
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownHeaderTextLinks.json

@@ -0,0 +1,33 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-header-text-links"
+  },
+  "props": {
+    "menu": {
+      "type": "Array",
+      "desc": "Array of menu items to display in the header",
+      "examples": [
+        "[{ name: 'Home', path: '/' }, { name: 'Docs', path: '/docs' }]"
+      ],
+      "category": "content"
+    },
+    "mqPrefix": {
+      "type": "String",
+      "desc": "Prefix for media query classes",
+      "examples": [
+        "'md'",
+        "'lg'"
+      ],
+      "category": "style"
+    },
+    "navClass": {
+      "type": "String",
+      "desc": "Additional CSS class to apply to navigation items",
+      "examples": [
+        "'custom-nav-class'"
+      ],
+      "category": "style"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownInstallation.json

@@ -0,0 +1,33 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-installation"
+  },
+  "props": {
+    "title": {
+      "type": "String",
+      "desc": "Title of the installation section",
+      "examples": [
+        "'Installation'",
+        "'Setup Guide'"
+      ],
+      "category": "content"
+    },
+    "id": {
+      "type": "String",
+      "desc": "ID for the installation card",
+      "examples": [
+        "'installation-section'"
+      ],
+      "category": "content"
+    },
+    "tabList": {
+      "type": "Array",
+      "desc": "List of tabs to display",
+      "examples": [
+        "['npm', 'yarn', 'pnpm']"
+      ],
+      "category": "content"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownLayout.json

@@ -0,0 +1,52 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-layout"
+  },
+  "props": {
+    "pageClass": {
+      "type": "String",
+      "desc": "CSS class to apply to the q-page component",
+      "examples": [
+        "'custom-page-class'"
+      ],
+      "category": "style"
+    },
+    "pageContentClass": {
+      "type": "String",
+      "desc": "CSS class to apply to the page content container",
+      "examples": [
+        "'custom-page-content-class'"
+      ],
+      "category": "style"
+    },
+    "isFullscreen": {
+      "type": "Boolean",
+      "desc": "Flag to indicate if the page is in fullscreen mode",
+      "category": "state"
+    }
+  },
+  "events": {
+    "scroll": {
+      "desc": "Emitted when the page is scrolled",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  },
+  "methods": {
+    "onPageScroll": {
+      "desc": "Handler for the page scroll event",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      },
+      "returns": null
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownLink.json

@@ -0,0 +1,23 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-link"
+  },
+  "props": {
+    "to": {
+      "type": "String",
+      "desc": "The target URL or path for the link",
+      "examples": [
+        "/home",
+        "https://example.com"
+      ],
+      "required": true,
+      "category": "navigation"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot for custom content inside the link"
+    }
+  }
+}

package/src/templates/init/src/_q-press/api/components/MarkdownPage.json

@@ -0,0 +1,71 @@
+{
+  "type": "component",
+  "meta": {
+    "docsUrl": "https://path-to-your-docs/markdown-page"
+  },
+  "props": {
+    "overline": {
+      "type": "String",
+      "desc": "Text to display as an overline above the title",
+      "examples": [
+        "'Introduction'",
+        "'Chapter 1'"
+      ],
+      "category": "content"
+    },
+    "title": {
+      "type": "String",
+      "desc": "Title of the markdown page",
+      "examples": [
+        "'Getting Started'",
+        "'API Reference'"
+      ],
+      "category": "content"
+    },
+    "badge": {
+      "type": "String",
+      "desc": "Badge text to display next to the title",
+      "examples": [
+        "'New'",
+        "'Updated'"
+      ],
+      "category": "content"
+    },
+    "editLink": {
+      "type": "String",
+      "desc": "URL for the edit link",
+      "examples": [
+        "'https://github.com/user/repo/edit/main/docs/page.md'"
+      ],
+      "category": "navigation"
+    },
+    "isFullscreen": {
+      "type": "Boolean",
+      "desc": "Flag to indicate if the page is in fullscreen mode",
+      "category": "state"
+    }
+  },
+  "slots": {
+    "default": {
+      "desc": "Slot for the main content of the markdown page"
+    }
+  },
+  "events": {
+    "edit": {
+      "desc": "Emitted when the edit button is clicked",
+      "params": {
+        "evt": {
+          "type": "Event",
+          "desc": "JS event object"
+        }
+      }
+    }
+  },
+  "methods": {
+    "toggleFullscreen": {
+      "desc": "Toggle the fullscreen mode of the markdown page",
+      "params": {},
+      "returns": null
+    }
+  }
+}