{"name":"@doc-tools/docs","author":{"name":"Yandex Data UI Team","email":"data-ui@yandex-team.ru"},"description":"Make documentation using yfm-docs in Markdown and HTML formats","license":"MIT","version":"1.27.0-beta.0","repository":{"type":"git","url":"git+ssh://git@github.com/yandex-cloud/yfm-docs.git"},"bin":{"yfm":"build/index.js"},"main":"build/index.js","scripts":{"build":"webpack","start":"node build/index.js","lint":"eslint \"src/**/*.{js,jsx,ts,tsx}\"","lint:fix":"npm run lint -- --fix","prepublishOnly":"npm run lint && npm run build"},"dependencies":{"@apidevtools/swagger-parser":"^10.1.0","@doc-tools/components":"2.0.0","@doc-tools/transform":"^2.8.2","@doc-tools/yfm2xliff":"0.0.3","@octokit/core":"3.5.1","@types/glob":"^8.0.0","ajv":"^8.11.0","aws-sdk":"2.1054.0","chalk":"4.1.2","glob":"^8.0.3","highlight.js":"10.7.3","js-yaml":"4.1.0","mime-types":"2.1.34","node-html-parser":"^5.3.3","react":"16.14.0","react-dom":"16.14.0","shelljs":"0.8.5","simple-git":"2.48.0","slugify":"^1.6.5","threads":"1.7.0","threads-plugin":"1.4.0","walk-sync":"2.2.0","yargs":"15.4.1"},"devDependencies":{"@babel/core":"7.16.7","@babel/plugin-proposal-class-properties":"7.16.7","@babel/plugin-syntax-top-level-await":"7.14.5","@babel/plugin-transform-runtime":"7.16.8","@babel/preset-env":"7.16.8","@babel/preset-react":"7.16.7","@babel/preset-typescript":"7.16.7","@babel/runtime":"7.16.7","@types/chalk":"2.2.0","@types/js-yaml":"4.0.5","@types/lodash":"4.14.178","@types/markdown-it":"10.0.3","@types/mime-types":"2.1.1","@types/node":"12.20.41","@types/react":"16.14.21","@types/react-dom":"16.9.14","@types/shelljs":"0.8.10","@types/yargs":"15.0.14","@typescript-eslint/eslint-plugin":"2.34.0","@typescript-eslint/parser":"2.34.0","babel-eslint":"10.1.0","babel-loader":"8.2.3","bem-cn-lite":"3.0.0","css-loader":"3.6.0","eslint":"6.8.0","eslint-plugin-react":"7.28.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-security":"1.4.0","husky":"4.3.8","lint-staged":"10.5.4","lodash":"4.17.21","mini-css-extract-plugin":"0.9.0","node-sass":"4.14.1","prop-types":"15.8.1","react-svg-loader":"3.0.3","sass-loader":"8.0.2","style-loader":"1.3.0","ts-jest":"27.1.2","typescript":"3.9.10","webpack":"4.46.0","webpack-cli":"3.3.12"},"husky":{"hooks":{"pre-commit":"lint-staged"}},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","git add"]},"pkg":{"scripts":["build/index.js","build/0.index.worker.js","build/plugins/*.js","build/lint-rules/*.js","build/default-lint-config.js","build/head-content.js"],"assets":"build/app.js"},"keywords":["markdown","yandex","docs","yfm","documentation","tool","tools","generator"],"contributors":[{"name":"The following authors have created the source code of \"Yandex Flavored Markdown Viewer\""},{"name":"published and distributed by YANDEX LLC as the owner:"},{"name":"Vladimir Fedin vladimirfedin@yandex-team.ru"},{"name":"Evgeny Biriulin birman111@yandex-team.ru"},{"name":"Evgeny Uspenskiy euspenskiy@yandex-team.ru"}],"readme":"**english** | [русский](https://github.com/yandex-cloud/yfm-docs/blob/master/README.ru.md)\n- - -\n\n[![NPM version](https://img.shields.io/npm/v/@doc-tools/docs.svg?style=flat)](https://www.npmjs.org/package/@doc-tools/docs)\n\n# yfm-docs\n\nYfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full\n[Yandex Flavored Markdown (YFM)](https://ydocs.tech) support.\n\n![Example of displaying a documentation page](docsAssets/overview.jpg)\n\n## Documentation\n\n[ydocs.tech](https://ydocs.tech/en/tools/docs/)\n\n## Usage\n\n```bash\nnpm i @doc-tools/docs -g\n```\n\n```bash\nnpm run start -- -i ./input-folder -o ./ouput-folder -v \"{\\\"name\\\":\\\"Alice\\\"}\"\n```\n\n## Source files\n\n### Preparation\n\nYou need to add `.env` file into repo root with data below:\n\n```bash\nGITHUB_OWNER=\nGITHUB_REPO= # docs\nGITHUB_TOKEN= # personal access token\nGITHUB_BASE_URL= # for ex: https://api.github.com\nVCS_CONNECTOR_TYPE= # github\n```\n\nor you can update .yfm file into docs repo\n\n```bash\nconnector:\n    type:\n    github:\n        endpoint:\n        token:\n        owner:\n        repo:\n```\n\n### Build from source\n\n```bash\ncd yfm-docs\nnpm ci && npm run build\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md","gitHead":"b3b1f6f8c212fdea4ac74219e84e7e4867c7de51","bugs":{"url":"https://github.com/yandex-cloud/yfm-docs/issues"},"homepage":"https://github.com/yandex-cloud/yfm-docs#readme","_id":"@doc-tools/docs@1.27.0-beta.0","_nodeVersion":"14.19.0","_npmVersion":"6.14.16","dist":{"integrity":"sha512-1VTK59i7P+nF/kdFrAa4b3yneRJxqHcEJyjaTW5f5ps9GpgSu2LHiQpNEmsq/pk1PoY2K4TLK0KiSfBbBURiFw==","shasum":"274175bd1625069101887b6de2617b731259214c","tarball":"https://registry.npmjs.org/@doc-tools/docs/-/docs-1.27.0-beta.0.tgz","fileCount":79,"unpackedSize":38604237,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD6OoNiiYF4PzKCsD2BXv6IWmeWchMmySJ9qR0rTq/LWgIgP07mK+t1NirCTaxE8li2jnwVlRFqOj0cucGdeXKmXh8="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjSSF9ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpqqA/+L8tLBVdcbq6tkzhCI15TZILmXaijLEo2coZpLLI0hGm6TWoR\r\nkpYONzUeSMrWfYa0ea1hfuh7s3wNJ6VZMfIWmvufDnpOjBMLG8SwgtasxNlT\r\nIqqO+NXbAFK6rVygtCgAcNs+XizKYAZWDLL9pC+XUnSAEmxAXJHy0G4Vtztk\r\nSJNjFPidtK7J0KBOakDOoEN5Jxdbd0izF/z306miX/b2be/OLo14DxLlLTyr\r\neEsdV0N4CX/lcBp3qtR/4Uza9gQrASqK5DaByAQ0F3nohW/P/B1YDBz4LnWi\r\nXktUw6VkQAS64CLa0IBWWGcDCKNmIuy2cL4i5SSXE3RXthYwOwiicNehYLLb\r\nziEJRTpnm61Ci66U0yh/ryXzmNB/apTqVfQW56x/Iq0HyaHeNVDmmBognjg8\r\nX3LGZOCM9l/ZM4S5FGjnXhSmPxWIYvEcZN8r2YNSKjStK6kIRTxygz/SqDaC\r\ntcPgaWF/1zpxU9oNBjCUkYNocLPRFGaMNRSPX1iDdWm7PPn/irzTdQ/yGUhY\r\nGRlveg+Cji90KvtZD2vBWVxA/1vDQ03y64Yydwcv+FxcR9CvSmeGBJQ610Sm\r\nRoz0swtDMRbD9PoJXRNv5Ywno/MWHYxjn0JmnHtA465iN6xG90TyqAJHmEW8\r\nDauUc91hjd6R3AiyPV8sNV10hGagF0qxXGk=\r\n=rLai\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"martyanov-av","email":"martyanovhi@gmail.com"},"directories":{},"maintainers":[{"name":"martyanov-av","email":"martyanovhi@gmail.com"},{"name":"moki","email":"morozov.kirill.moki@gmail.com"},{"name":"yc-ui-robot","email":"robot-cloud-st@yandex-team.ru"},{"name":"yfm-team","email":"yfm-team@yandex.ru"},{"name":"monsterzz","email":"borisov.gleb@gmail.com"},{"name":"buran","email":"burashka-lcme@yandex.ru"},{"name":"yndx-birman111","email":"yndx-birman111@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docs_1.27.0-beta.0_1665737084659_0.2731594713137886"},"_hasShrinkwrap":false}