UNPKG

mxdocgen

Version:

A small tool that mimics the documentation generation capabilities offered in Mendix Studio Pro, but with greater flexibility. It uses the Mendix Model SDK to extract information from a Mendix model, which is then fed into a set of templates to generate

80 lines (79 loc) 2.6 kB
{ "name": "mxdocgen", "version": "1.2.1", "description": "A small tool that mimics the documentation generation capabilities offered in Mendix Studio Pro, but with greater flexibility.\n\nIt uses the Mendix Model SDK to extract information from a Mendix model, which is then fed into a set of templates to generate the required output, such as an .html document.\nFilters can be applied to control which modules and documents should be processed.\n\nThe tool can be used as a standalone (node-based) CLI or as a library.", "keywords": [ "Mendix", "documentation", "mpk" ], "author": "Kevin Vlaanderen", "license": "ISC", "homepage": "https://github.com/KevinVlaanderen/MxDocGen#readme", "repository": { "type": "git", "url": "https://github.com/KevinVlaanderen/MxDocGen.git" }, "bugs": { "url": "https://github.com/KevinVlaanderen/MxDocGen/issues" }, "main": "dist/index.js", "bin": "dist/cli/cli.js", "types": "dist/index.d.ts", "scripts": { "build": "npm run clean-generated && tsc", "clean": "npm run clean-generated && npm run clean-output", "docs": "npm run readme && npm run typedoc", "prepare": "npm run build", "start": "npm run build && node dist/cli/cli.js", "clean-generated": "rimraf dist/", "clean-output": "rimraf out/", "readme": "node build/readme.js", "typedoc": "typedoc && touch docs/.nojekyll", "barrels": "barrelsby --delete -d src -e __tests__ -l top -s filesystem", "prettier": "pretty-quick --verbose --write **/*.*", "prettier-check": "pretty-quick --verbose --check **/*.*" }, "prettier": { "printWidth": 100, "tabWidth": 4, "useTabs": true }, "husky": { "hooks": { "pre-commit": "pretty-quick --staged" } }, "dependencies": { "@types/when": "^2.4.33", "fs-extra": "^8.1.0", "ignore": "^5.1.4", "mendixmodelsdk": "^4.29.0", "mendixplatformsdk": "^4.1.1", "mustache": "^4.0.0", "pkg-dir": "^4.2.0", "uuid": "^3.4.0", "when": "^3.7.8", "yargs": "^15.1.0" }, "devDependencies": { "@types/fs-extra": "^8.1.0", "@types/jest": "^25.1.2", "@types/mustache": "^4.0.0", "@types/node": "^13.7.1", "@types/uuid": "^3.4.7", "@types/yargs": "^15.0.3", "barrelsby": "^2.2.0", "husky": "^4.2.3", "jest": "^25.1.0", "prettier": "^1.19.1", "pretty-quick": "^2.0.1", "readme-md-generator": "^1.0.0", "rimraf": "^3.0.2", "shelljs": "^0.8.3", "ts-jest": "^25.2.1", "ts-node": "^8.6.2", "typedoc": "^0.16.11", "typescript": "^3.7.5" } }