1.10.40. fejezet, Dokumentáció készítés

Beküldte pzoli - 2023, július 25 - 6:56du

Kapcsolódó hivatkozások

JSDoc telepítése

npm i -D jsdoc

Konfigurációs fájl (jsdoc.json)

{
  "source": {
    "include": ["src"],
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": true,
    "monospaceLinks": true
  },
  "opts": {
    "recurse": true,
    "destination": "./docs/"
  }
}

Futtatáshoz szükséges script beállítások (package.json)

{
  "name": "jsdoc_example",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "doc": "jsdoc -c jsdoc.json"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "jsdoc": "^3.6.3"
  }
}

Futtatás

npm run doc

TypeDoc telepítése

npm install --save-dev typedoc

Futtatás

npx typedoc src/index.ts

Konfigurációs fájl (typedoc.json)

{
    "$schema": "https://typedoc.org/schema.json",
    "entryPoints": ["./src/index.ts", "./src/secondary-entry.ts"],
    "out": "doc"
}