{"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.15.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","test":"npm run build && jest"},"dependencies":{"@doc-tools/components":"^1.10.1","@doc-tools/transform":"^2.0.10","@octokit/core":"^3.3.0","aws-sdk":"^2.773.0","chalk":"^4.0.0","highlight.js":"^10.4.0","js-yaml":"^4.0.0","markdown-it":"^10.0.0","markdown-it-imsize":"^2.0.1","mime-types":"^2.1.27","react":"^16.13.1","react-dom":"^16.13.1","shelljs":"^0.8.4","simple-git":"^2.37.0","walk-sync":"^2.1.0","yargs":"^15.3.1"},"devDependencies":{"@babel/core":"^7.9.0","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-syntax-top-level-await":"^7.12.13","@babel/plugin-transform-runtime":"^7.13.10","@babel/preset-env":"^7.13.10","@babel/preset-react":"^7.12.13","@babel/preset-typescript":"^7.9.0","@babel/runtime":"^7.13.10","@types/chalk":"^2.2.0","@types/jest":"^27.0.1","@types/js-yaml":"^4.0.0","@types/lodash":"^4.14.167","@types/markdown-it":"^10.0.0","@types/mime-types":"^2.1.0","@types/node":"^12.12.31","@types/react":"^16.9.23","@types/react-dom":"^16.9.5","@types/shelljs":"^0.8.7","@types/yargs":"^15.0.4","@typescript-eslint/eslint-plugin":"^2.27.0","@typescript-eslint/parser":"^2.29.0","babel-eslint":"^10.1.0","babel-loader":"^8.1.0","bem-cn-lite":"^3.0.0","css-loader":"^3.4.2","eslint":"^6.8.0","eslint-plugin-react":"^7.19.0","eslint-plugin-react-hooks":"^3.0.0","eslint-plugin-security":"^1.4.0","husky":"^4.2.5","jest":"^27.2.3","lint-staged":"^10.1.7","lodash":"^4.17.15","mini-css-extract-plugin":"^0.9.0","node-sass":"^4.14.0","prop-types":"^15.7.2","react-svg-loader":"^3.0.3","sass-loader":"^8.0.2","style-loader":"^1.1.3","ts-jest":"^27.0.5","typescript":"^3.9.2","webpack":"^4.42.1","webpack-cli":"^3.3.11"},"husky":{"hooks":{"pre-commit":"lint-staged && npm run test"}},"lint-staged":{"*.{js,jsx,ts,tsx}":["eslint --fix","git add"]},"pkg":{"scripts":["build/index.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://www.npmjs.com/package/@doc-tools/transform) support. For example, [Yandex.Cloud documentation](https://cloud.yandex.ru/docs).\n\n![Example of displaying a documentation page](docsAssets/overview.jpg)\n\n## Installation\n\n```shell script\nnpm i @doc-tools/docs -g\n```\n\n## Usage\n\n```shell script\nyfm -i ./input-folder -o ./ouput-folder -v \"{\\\"name\\\":\\\"Alice\\\"}\"\n```\n\n## List of possible parameters\n\n- `--input, -i`\n\n    Path to the project directory (required parameter).\n\n- `--output, -o`\n\n    Path to the output directory (required parameter).\n\n- `--allowHTML`\n\n    Allow the use of HTML in MD files.\n\n- `--varsPreset`\n\n    Name of the used [preset](./DOCS.md#presets).\n\n- `--vars, -v`\n\n    Values of [YFM variables](https://github.com/yandex-cloud/yfm-transform/blob/master/DOCS.md#vars)\n\n- `--strict, -s`\n\n    Start in strict mode.\n\n    YFM warnings are treated as errors. Disabled by default.\n\n- `--quiet, -q`\n\n    Start in quiet mode.\n\n    Do not output logs to stdout. Disabled by default.\n\n- `--config, -c`\n\n    Path to the [YFM configuration file](./DOCS.md#config).\n\n- `--output-format`\n\n    Generation format: HTML or MD. By default, HTML.\n\n- `--apply-presets`\n\n    Shows whether to apply [presets](./DOCS.md#presets) when converting md2md.\n\n- `--resolve-conditions`\n\n    Shows whether to apply conditions when converting md2md.\n    \n- `--disable-liquid`\n    \n    Indicates whether to disable the use of the template engine\n\n- `--ignore-stage`\n\n    Ignore tocs with stage.\n\n- `--publish`\n\n    Should upload output files to S3 storage. Disabled by default.\n\n- `--contributors`\n\n    Should attach contributors into files. Disabled by default.\n\n- `--add-system-meta`\n\n    Should add system section variables from presets to file meta data. Disabled by default.\n\n- `--version`\n\n    Current version.\n\n- `--help`\n\n    List of commands.\n    \n- `--remove-hidden-toc-items`\n    \n    Should whether to remove hidden pages from the build result. Disabled by default.\n    \n- `--disable-lint`\n    \n    Should whether to turn of a linter. Disabled by default.\n\nLearn more `yfm-docs --help`\n\n[Learn more about the project structure](./DOCS.md)\n\n## Build result\n\nThe built project is a set of static HTML pages that can be viewed locally, hosted on a hosting service,\non GitHub Pages, or in [S3](https://cloud.yandex.ru/services/storage):\n\n```\noutput-folder\n|-- index.html (Documentation leading page)\n|-- quickstart.html (Document files and images)\n|-- pages\n    |-- faq.html\n    |-- how-to.html\n|-- assets\n    |-- image1.png\n    |-- image2.png\n|-- includes\n    |-- faq_shared_block.html\n```\n\n### Building a project in YFM\n\nYou can also build your project in YFM using the `--output-format=md` key.\n\nIn this case:\n\n- Inserts in ToC files [are applied](./DOCS.md#tocIncludes).\n- Conditions in the content and ToC files are calculated.\n- Variables are applied if the `apply-presets` parameter is specified.\n- All files specified in the ToC files, images used in them, and [insert files](https://github.com/yandex-cloud/yfm-transform/blob/master/DOCS.md#includes) will be copied.\n\nLearn more about variables and conditions in [YFM documentation](https://github.com/yandex-cloud/yfm-transform/blob/master/DOCS.md#vars).\n\n```\ninput-folder\n|-- index.yaml (Documentation leading page)\n|-- quickstart.md (Document files and images)\n|-- pages\n    |-- faq.md\n    |-- how-to.md\n|-- assets\n    |-- image1.png\n    |-- image2.png\n|-- includes\n    |-- faq_shared_block.md\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### Installation\n\n```bash\ncd yfm-docs\nnpm ci && npm run build\n```\n\n### Usage\n\n```bash\nnpm run start -- -i ./input-folder -o ./ouput-folder -v \"{\\\"name\\\":\\\"Alice\\\"}\"\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md","gitHead":"95f9d2500fe0d83a0a5c90d19197187b785309fd","bugs":{"url":"https://github.com/yandex-cloud/yfm-docs/issues"},"homepage":"https://github.com/yandex-cloud/yfm-docs#readme","_id":"@doc-tools/docs@1.15.1-beta.0","_nodeVersion":"12.18.1","_npmVersion":"6.14.5","dist":{"integrity":"sha512-z4AeLL4i0C0/qeRcNuXrnK5PXsD5499v8MDrVi3lXP4Xl6RxDgqoFdqCPOjGJOUZMe2yXj1C8p3n8H/XmIWSaA==","shasum":"1f3ff1a1bcdc7b65d2b10b0efe026e32d364bb9a","tarball":"https://registry.npmjs.org/@doc-tools/docs/-/docs-1.15.1-beta.0.tgz","fileCount":50,"unpackedSize":24237206,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhn3p4CRA9TVsSAnZWagAAsmAP+wb4zmHw7UK1pcbpuO5i\n8oRZ4xfMAutN96azm7uXhD8210sj+Mu/SekxPjbkq7Ejvy58AAQkqE1Xjp1R\nv/t6btwVX7HpHaEOgt9ybcj4QQdP6mzBBQXOBvglmIJ34I83v8eXCVLVQckY\ngr4VvCjnP//As67S95ivwTuD3Ixm/epmLxR20X8W0V66kT4Kbxm0cpC3k8Dl\nzOxlOlt3KyGJ36o68OENnUksSJl46Gztbzxk6OcoBjgMQgLUE9gWYJImMBKH\nDi/K0m08VBW4rklhYXdA+EgFzvqN6W/nA2WNN+HeF2TdaRalNzUqeBq5b7PN\n6TrpltzH24YTzKg0r5bsnj0Bz9QROyii12hQNeQEPdVIXqzmbLDRzQGMog7O\ni8Cmkp5PITB36mHCvyMbVa5fBKhXTlW5YiOaSrCEuVtDuhk1Zp9f16oqUnTI\nqiYDlPDqNxEaZEcXMR0OPESUIkjSL7HEvXh2JWL0j6sXX1L2h8h8VpQZ+JAe\niXBUDT7VRwphxWH8/q+7/pj7wEN6bCnGtYxZcruuQjmOvdGR0vmXck7KUKGA\nW34qUc/qsP30o8u8qk7pp8jBZRXKKh60B+Xmc78vDo/g4+uQUOfiIjBcZv/v\nqK9gzmRcOxZa0XY7CKoUqJ84Shnl3kCe5jJFhno9iqhqOuHmVPDqok8maiDx\nA7K5\r\n=qtHR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHszAB8IqpgNg6vHslZ/AbOevDAnQpAcLkHxKlZdELD0AiEAtGCUWmWyenhy35/hVoeeAtANuZNCHbfjI9803ouEgJM="}]},"_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.15.1-beta.0_1637841528433_0.581980170456305"},"_hasShrinkwrap":false}