ts-pkgx/dist/packages/mkdocsorg.d.ts

A library & CLI for managing packages

/**
 * **mkdocs** - Project documentation with Markdown.
 *
 * @domain `mkdocs.org`
 * @programs `mkdocs`
 * @version `1.6.1` (3 versions available)
 * @versions From newest version to oldest.
 *
 * @install `launchpad install mkdocs`
 * @name `mkdocs`
 * @dependencies `python.org>=3<3.12`
 *
 * @example
 * ```typescript
 * import { pantry } from 'ts-pkgx'
 *
 * // Access the package
 * const pkg = pantry.mkdocs
 * // Or access via domain
 * const samePkg = pantry.mkdocsorg
 * console.log(pkg === samePkg) // true
 * console.log(pkg.name)        // "mkdocs"
 * console.log(pkg.description) // "Project documentation with Markdown."
 * console.log(pkg.programs)    // ["mkdocs"]
 * console.log(pkg.versions[0]) // "1.6.1" (latest)
 * ```
 *
 * @see https://ts-pkgx.netlify.app/packages/mkdocs-org.md
 * @see https://ts-pkgx.netlify.app/usage
 */
export declare const mkdocsPackage: {
  /**
   * The display name of this package.
   */
  name: 'mkdocs';
  /**
   * The canonical domain name for this package.
   */
  domain: 'mkdocs.org';
  /**
   * Brief description of what this package does.
   */
  description: 'Project documentation with Markdown.';
  packageYmlUrl: 'https://github.com/pkgxdev/pantry/tree/main/projects/mkdocs.org/package.yml';
  homepageUrl: '';
  githubUrl: 'https://github.com/pkgxdev/pantry/';
  /**
   * Command to install this package using launchpad.
   * @example launchpad install package-name
   */
  installCommand: 'launchpad install mkdocs';
  /**
   * Executable programs provided by this package.
   * These can be run after installation.
   */
  programs: readonly ['mkdocs'];
  companions: readonly [];
  /**
   * Required dependencies for this package.
   * These will be automatically installed.
   */
  dependencies: readonly ['python.org>=3<3.12'];
  /**
   * Available versions from newest to oldest.
   * @see https://ts-pkgx.netlify.app/usage for installation instructions
   */
  versions: readonly ['1.6.1', '1.6.0', '1.5.3'];
  /**
   * Alternative names for this package.
   * You can use any of these names to access the package.
   */
  aliases: readonly [];
  pkgxInstallCommand: 'sh <(curl https://pkgx.sh) mkdocs -- $SHELL -i';
  launchpadInstallCommand: 'launchpad install mkdocs'
};
export type MkdocsPackage = typeof mkdocsPackage