{"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.21.1-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":{"@doc-tools/components":"2.0.0","@doc-tools/transform":"^2.5.12","@octokit/core":"3.5.1","aws-sdk":"2.1054.0","chalk":"4.1.2","highlight.js":"10.7.3","js-yaml":"4.1.0","mime-types":"2.1.34","react":"16.14.0","react-dom":"16.14.0","shelljs":"0.8.5","simple-git":"2.48.0","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":"138ce5ccd90260a2cdc7c20399796315edf691b9","bugs":{"url":"https://github.com/yandex-cloud/yfm-docs/issues"},"homepage":"https://github.com/yandex-cloud/yfm-docs#readme","_id":"@doc-tools/docs@1.21.1-beta.0","_nodeVersion":"14.17.5","_npmVersion":"6.14.14","dist":{"integrity":"sha512-qjGc2TH8a8yr4MPBYb0ylakYVRz8FGLXAgrpLRNPypzHCCKubfD2XFVJgWXoBotGx2GakNG9evZeEHTEQpJY1A==","shasum":"543d164c15680668fce04ada4aeb80fcf322ab99","tarball":"https://registry.npmjs.org/@doc-tools/docs/-/docs-1.21.1-beta.0.tgz","fileCount":58,"unpackedSize":25327919,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHY+3WKvvQ3Mnvv+3L8HGiQYDPj5EVa+DgNTqh1AwaSQAiAoDLam2FMUoyOlO1XmUrazCIzeGYRtY4kvX/ri8F9cnw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiT7N3ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo7Bw/9Guig4sXTjol2dEQEwmNfr/7qEzKoDC+g7Ewb7DgIHn8T8AbN\r\nwWHTNAQ8Cx1A8getqT2qvllc8Q+AbvdfKUUrV6mywngr2Om8YPh5IhTAGEz+\r\n7VXtlermY5yXIFFda5tcAesMh69eB4yp+gN80KdAx8GVBtfUjTx4+bCg1D2r\r\nP+3MEZJWiMyU0VIU6O71ecESRjK7Kaa9Nq+hLlUQP6u0QqxaPgdDNjzlxJHD\r\nPYtwua7QM8icIvFN+vaJcx0W+QSvz5IUYlmenCTAhd9LHor2zI3IAikr/xHc\r\npGp3w31H6M4boTkw2UTERioBUnVH/PudRzRbsqlgjEIR8+JxWOEodcgRfZNC\r\nZhML3YxFWzhoE24m4E4IcKrM4UwXcyboMYJ85A1rbkuaM8HjIGm0R/+Z2xmJ\r\n+oCK/6cLFH35o6wkFaByx0VF59ej9XjsjrzViUZIvHPmJq6cpS9ldD93Jaqu\r\nWVbFzvw7/gtzwPuIz/xIFmDsuXyloO0QF18IZD/bSmYPuyDb1XrY2ofBCSsi\r\na8SFBMi55fP1I2kTPZJam2JZC/wvRbHLfNQxQAAXb21mNHZEl6UPk4Tahh1Y\r\nQDBVcJg7KkAxta8/Gh3uQh285FOWPSmkKunmfm56vEcjktHgKl2/qJ2kIrdu\r\nOKMubwjWMpN5p5pvJvGVr21Q5sOfwoZAvI8=\r\n=X+IM\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"yndx-birman111","email":"yndx-birman111@yandex.ru"},"directories":{},"maintainers":[{"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.21.1-beta.0_1649390455543_0.9824127878828912"},"_hasShrinkwrap":false}