@ink-feather-org/typedoc-plugin-asciidoctor/package.json

Adds README.adoc support to typedoc.

{
  "private": false,
  "author": "raldone01",
  "description": "Adds README.adoc support to typedoc.",
  "homepage": "feather.ink",
  "license": "GPL-3.0-or-later",
  "publishConfig": {
    "registry": "https://registry.npmjs.org/"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/ink-feather-org/typedoc-plugin-asciidoctor"
  },
  "name": "@ink-feather-org/typedoc-plugin-asciidoctor",
  "version": "1.0.6",
  "main": "dist/src/index.js",
  "module": "dist/src/index.js",
  "sideEffects": false,
  "types": "dist/src/index.d.ts",
  "keywords": [
    "typedoc",
    "asciidoctor",
    "adoc",
    "typedoc-plugin",
    "typedocplugin"
  ],
  "devDependencies": {
    "@ink-feather-org/eslint-config-shareable": "^1.0.9",
    "@typescript-eslint/eslint-plugin": "^5.17.0",
    "@typescript-eslint/parser": "^5.17.0",
    "eslint": "^8.12.0",
    "eslint-config-airbnb-typescript": "^16.2.0",
    "eslint-plugin-import": "^2.25.4",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^6.0.0",
    "npm-multi-publish": "^2.2.0",
    "shx": "^0.3.4",
    "typedoc": "^0.22.13",
    "typescript": "^4.6.3",
    "@types/node": "^17.0.23"
  },
  "dependencies": {
    "tslib": "^2.3.1",
    "@ink-feather-org/ts-utils": "^1.0.11",
    "@ink-feather-org/asciidoctor-shiki": "^1.0.0",
    "@babel/runtime-corejs3": "^7.17.8",
    "@asciidoctor/core": "^2.2.6"
  },
  "peerDependencies": {
    "typedoc": "^0.22.13"
  },
  "scripts": {
    "check-types": "tsc --noEmit",
    "lint": "eslint . --ext .ts,.js",
    "lint:fix": "eslint . --ext .ts,.js --fix",
    "test": "cd test && pnpm run test",
    "test:lint": "cd test && pnpm run lint",
    "test:lint:fix": "cd test && pnpm run lint:fix",
    "build:declarations": "tsc --declaration --emitDeclarationOnly",
    "build:bundle": "tsc",
    "build": "pnpm run build:bundle && pnpm run build:declarations",
    "docs": "pnpm typedoc",
    "clean": "shx rm -rf dist docs"
  },
  "readme": "# @ink-feather-org/typedoc-plugin-asciidoctor\r\n\r\nThis plugin adds README.adoc support to typedoc.\r\nTo use this plugin specify the `readme` option for typedoc.\r\n\r\n# tsconfig.json\r\n\r\n```json\r\n{\r\n  \"typedocOptions\": {\r\n    \"entryPoints\": [\"src/index.ts\"],\r\n    \"out\": \"docs\",\r\n    \"readme\": \"README.adoc\",\r\n    \"excludePrivate\": true,\r\n    \"plugin\": [ \"@ink-feather-org/typedoc-plugin-asciidoctor\" ]\r\n  }\r\n}\r\n```\r\n\r\nnpmjs.com does not support .adoc readme files.\r\nFor the full readme see [the git repository](https://github.com/ink-feather-org/ts-utils).\r\n"
}