@do11y/docs 0.0.1 → 0.0.3

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/files.d.ts

@@ -0,0 +1,4 @@
+export declare const ui: string;
+export declare const root: string;
+export declare const docs: string;
+export declare const plugins: string;

package/dist/files.js

@@ -3,6 +3,6 @@ import { createRequire } from 'node:module';
 import { searchForWorkspaceRoot } from 'vite';
 const require = createRequire(import.meta.url);
 export const ui = join(dirname(require.resolve('@do11y/ui/package.json')));
-export const root = join(searchForWorkspaceRoot(process.cwd()), 'example');
+export const root = searchForWorkspaceRoot(process.cwd());
 export const docs = join(root, 'docs');
 export const plugins = join(docs, 'site', 'plugins.ts');

package/dist/html/html.d.ts

@@ -0,0 +1,2 @@
+import type { Plugin } from 'vite';
+export declare const html: (folder: string, key: "index" | "sandbox") => Omit<Plugin, "name">;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { PluginOptions } from './plugin-options.js';
+import type { Site } from './plugins/site/site.js';
+export type { Site, PluginOptions };

package/dist/plugin-options.d.ts

@@ -0,0 +1,6 @@
+import type { MarkdownPluginOptions } from './plugins/markdown/markdown.js';
+export type PluginOptions = MarkdownPluginOptions;
+/**
+ * Access plugin options (`docs/site/plugins.ts`).
+ */
+export declare const pluginOptions: PluginOptions;

package/dist/plugins/markdown/markdown.d.ts

@@ -0,0 +1,36 @@
+import { type MarkdownSfcBlocks } from '@mdit-vue/plugin-sfc';
+import type { PluginOptions, MarkdownItEnv as Env } from 'markdown-it-vue-meta';
+import type { PluginSimple } from 'markdown-it';
+import type { Plugin } from 'vite';
+import type MarkdownIt from 'markdown-it';
+export interface MarkdownPluginOptions {
+    /**
+     * Additional markdown-it setup.
+     */
+    setup?: PluginSimple;
+    /**
+     * The highlight option for `markdown-it`.
+     */
+    highlight?: (md: MarkdownIt, code: string, lang: string, attrs: string) => string;
+    /**
+     * The renderer option for `markdown-it-vue-meta`.
+     */
+    metaRenderer?: PluginOptions['renderer'];
+}
+export interface MarkdownItEnv extends Env {
+    /**
+     * Blocks extracted by `@mdit-vue/plugin-sfc`.
+     */
+    sfcBlocks?: MarkdownSfcBlocks;
+    /**
+     * Blocks extracted by `@mdit-vue/plugin-frontmatter`.
+     */
+    frontmatter?: Record<string, unknown>;
+}
+/**
+ * Processes blocks with the lang set to `md` into HTML,
+ * and turns `.md` files into single file vue components
+ * - using `markdown-it`.
+ */
+declare const _default: (options?: MarkdownPluginOptions) => Plugin;
+export default _default;

package/dist/plugins/plugins.d.ts

@@ -0,0 +1,2 @@
+import type { Plugin } from 'vite';
+export declare const plugins: () => Plugin[];

package/dist/plugins/routes/routes.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from 'vite';
+/**
+ * Adds the ability to import routes (`*.md` files)
+ * through `do11y:routes`.
+ */
+declare const _default: () => Plugin;
+export default _default;

package/dist/plugins/sandbox/sandbox.d.ts

@@ -0,0 +1,8 @@
+import type { Plugin } from 'vite';
+/**
+ * Creates a seprate sandbox app, and
+ * adds the ability to declare sandbox components
+ * which you can access through `do11y:sandbox`.
+ */
+declare const _default: () => Plugin;
+export default _default;

package/dist/plugins/site/site.d.ts

@@ -0,0 +1,19 @@
+import type { Plugin } from 'vite';
+import type { App, Component } from 'vue';
+import type { Router } from 'vue-router';
+export type Site = {
+    /**
+     * The main component for the site.
+     */
+    Site: () => Promise<Component>;
+    /**
+     * Additional setup for the app.
+     */
+    setup?(app: App, router: Router): void | Promise<void>;
+};
+/**
+ * Add ability to access the site options (`docs/site/index.ts`)
+ * through `do11y:site`.
+ */
+declare const _default: () => Plugin;
+export default _default;

package/dist/plugins/ui/ui.d.ts

@@ -0,0 +1,6 @@
+import type { Plugin } from 'vite';
+/**
+ * The main application.
+ */
+declare const _default: () => Plugin;
+export default _default;

package/dist/vite-config.d.ts

@@ -0,0 +1,2 @@
+export declare const getUserViteConfig: (command: "dev" | "build" | "preview") => Promise<import("vite").UserConfig>;
+export declare const getViteConfig: (command: "dev" | "build" | "preview") => Promise<Record<string, any>>;

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@do11y/docs",
-  "version": "0.0.1",
+  "description": "A very bare-bones tool to help document Vue components.",
+  "version": "0.0.3",
   "type": "module",
   "repository": {
     "type": "git",
@@ -15,7 +16,10 @@
     "do11y": "./bin/bin.js"
   },
   "exports": {
-    ".": "./dist/index.js",
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
     "./types": "./routes.d.ts"
   },
   "peerDependencies": {