{"_id":"@brisk-docs/gatsby-generator","_rev":"3-fb26b1e55c5e75cd53120bc689f67560","name":"@brisk-docs/gatsby-generator","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@brisk-docs/gatsby-generator","version":"1.0.0","description":"The Brisk website documenter","main":"dist/gatsby-generator.cjs.js","module":"dist/gatsby-generator.esm.js","maintainers":[{"name":"dpisani-atl","email":"dpisani@atlassian.com"},{"name":"noviny","email":"benjaminconolly@gmail.com"}],"license":"MIT","scripts":{"dev":"node bin.js dev --config=dummy-data/simple-project/docs.config.js","dev:complete":"node bin.js dev --config=dummy-data/complete-config-project/docs.config.js","dev:webpack":"node bin.js dev --config=dummy-data/custom-webpack-project/docs.config.js","build:site":"node bin.js build --config=dummy-data/simple-project/docs.config.js","build:site:complete":"node bin.js build --config=dummy-data/complete-config-project/docs.config.js","export:site":"node bin.js export --config=dummy-data/simple-project/docs.config.js","build":"echo no build set yet for website","start":"node bin.js start","start:complete":"node bin.js dev --config=dummy-data/complete-config-project/docs.config.js"},"bin":{"brisk":"bin.js"},"engines":{"node":">=10.0.0"},"preconstruct":{"entrypoints":[".","handle-config"]},"dependencies":{"@atlaskit/breadcrumbs":"^8.0.0","@atlaskit/button":"^8.2.4","@atlaskit/code":"^9.0.0","@atlaskit/css-reset":"^3.0.5","@atlaskit/drawer":"^2.7.1","@atlaskit/dynamic-table":"^13.5.0","@atlaskit/icon":"^16.0.1","@atlaskit/navigation-next":"^4.1.2","@atlaskit/quick-search":"^5.2.5","@atlaskit/section-message":"^4.1.1","@atlaskit/table-tree":"^7.1.2","@atlaskit/theme":"^6.0.0","@atlaskit/tree":"^4.1.11","@atlaskit/width-detector":"^0.3.1","@babel/plugin-proposal-class-properties":"^7.3.4","@babel/preset-react":"^7.0.0","@babel/runtime":"^7.4.3","@brisk-docs/file-viewer":"^0.2.4","@brisk-docs/react-changelogs":"^0.1.10","@emotion/core":"^10.0.9","@emotion/styled":"^10.0.9","@mdx-js/loader":"^0.17.5","@mdx-js/mdx":"^1.0.0","@mdx-js/react":"^1.5.0","@reach/router":"^1.2.1","babel-loader":"^8.0.5","babel-plugin-transform-dynamic-import":"^2.1.0","babel-plugin-transform-flow-strip-types":"^6.22.0","command-line-args":"^5.0.2","emotion":"^9.1.3","emotion-server":"^9.2.12","extract-react-types-loader":"^0.3.7","filenamify":"^4.0.0","fs-extra":"^7.0.1","gatsby":"^2.15.28","gatsby-plugin-emotion":"^2.0","gatsby-plugin-manifest":"^2.2.26","gatsby-plugin-mdx":"^1.0.46","gatsby-plugin-page-creator":"^2.1.23","gatsby-plugin-react-helmet":"^3.1.10","gatsby-plugin-styled-components":"^3.1.8","gatsby-plugin-typescript":"^2.1.11","gatsby-source-filesystem":"^2.1.28","git-url-parse":"^11.1.2","glob":"^7.1.3","jest-fixtures":"^0.6.0","js-yaml":"^3.13.1","lodash.capitalize":"^4.2.1","lodash.debounce":"^4.0.8","lodash.flatten":"^4.4.0","lodash.identity":"^3.0.0","lodash.snakecase":"^4.1.1","outdent":"^0.7.0","pkg-dir":"^4.2.0","pretty-proptypes":"^0.6.6","prismjs":"^1.15.0","prop-types":"^15.6.2","raw-loader":"^1.0.0","react":"16.10.2","react-addons-text-content":"^0.0.4","react-dom":"^16.8.4","react-helmet":"^5.2.1","remark-frontmatter":"^1.3.2","remark-parse":"^6.0.3","title-case":"^2.1.1","unified":"^7.1.0","unist-util-visit":"^1.3.0"},"devDependencies":{"@atlaskit/avatar":"^17.1.3","@atlaskit/dropdown-menu":"^6.1.26","@types/fs-extra":"^8.0.0","enzyme":"^3.9.0","enzyme-adapter-react-16":"^1.9.1","mock-fs":"^4.10.1","styled-components":"^3.2.6"},"peerDependencies":{"styled-components":"^3.2.6"},"_id":"@brisk-docs/gatsby-generator@1.0.0","_npmVersion":"6.4.1","_nodeVersion":"10.13.0","_npmUser":{"name":"noviny","email":"benjaminconolly@gmail.com"},"dist":{"integrity":"sha512-yarKGNsi1J2EK7d3qybCq5ogvWYarUKsqyPaRGQ6ntJNIrmo59GqQ/UaBCHnWsL5RkLVGraYch+Dex91RsoOOg==","shasum":"8903da005ab64d4b4514cada60774036fcd2fe5d","tarball":"https://registry.npmjs.org/@brisk-docs/gatsby-generator/-/gatsby-generator-1.0.0.tgz","fileCount":117,"unpackedSize":1095465,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdwLZJCRA9TVsSAnZWagAAyqkP/AuZLdV6s4BhJxYxYjgi\nO6R/5DvCdSpkW2O+7uE1kqv6bZLiLIgITx9nlYdZE+y0AWYv8C00FlPXf9H/\nyhz9I5bfl6R7kj3IPwaoc2ADJoFDJ1lFeHLkOzmkVnv8euv14BMXSY/jJy+9\nFaIjSk3kSimlPvQtMCeH/Jw8z8/qmUZZ7FELE84CXyqnxENlMXiyXOkLfodY\nXZ3NFc0aoA7NW3qzEhUg6m6ChRCWjdZRmphaAyKwQeb8IPS9NlbX56wD5L5j\nZgL8RsT52eRWXU0KpTCv9BaIlpsC+n5G3sFonONhNKncFxt9/ssWy505rR6e\nfWRfFEy0JhHVVrq4vYweJ/8rm0EwsixFlcypaTajs2T7ChL1nzdhoNhGbnHQ\nL75EKl8pdFWYyGwnxp7e7BA97O+a7zpdwpI3W2DB8oHSfiiZplAKxJWLSya5\n1YFXOtxJqlyajT8jRmCyjPOJfQB4TRgvrrChflCX8zSSS5Hkgz1Qgxk9vVjp\nAEO9yWfYCpA7WS6Vvd4sWfBRZcHokdyikmb7A6ETtABe7lLeAUXL9ttz82Ap\noA6AA7OjZ6kIbkHuBD6aSlOqLU1ejRFJMc8Fn7rdQi12guKs5A48tvnAyGh+\n1b/YjsBql7weN8LQGVasaD5uEP2UIjPR6Ix5CEopJM8r9FAwWLPnkKYPiBL6\nTXgo\r\n=/Uu3\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD+NJx1H0f9dhCGwOHOyk3oXXfzMJ0KfK0Z83Dptn5WyAIhAKWmEuKQ6aGODwsmCJvtq4/XknKhv4UhGZVwcVVK0QUy"}]},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gatsby-generator_1.0.0_1572910664784_0.4527222949743972"},"_hasShrinkwrap":false},"1.0.1":{"name":"@brisk-docs/gatsby-generator","version":"1.0.1","description":"The Brisk website documenter","main":"dist/gatsby-generator.cjs.js","module":"dist/gatsby-generator.esm.js","maintainers":[{"name":"dpisani-atl","email":"dpisani@atlassian.com"},{"name":"noviny","email":"benjaminconolly@gmail.com"}],"license":"MIT","scripts":{"dev":"node bin.js dev --config=dummy-data/simple-project/docs.config.js","dev:complete":"node bin.js dev --config=dummy-data/complete-config-project/docs.config.js","dev:webpack":"node bin.js dev --config=dummy-data/custom-webpack-project/docs.config.js","build:site":"node bin.js build --config=dummy-data/simple-project/docs.config.js","build:site:complete":"node bin.js build --config=dummy-data/complete-config-project/docs.config.js","export:site":"node bin.js export --config=dummy-data/simple-project/docs.config.js","build":"echo no build set yet for website","start":"node bin.js start","start:complete":"node bin.js dev --config=dummy-data/complete-config-project/docs.config.js"},"bin":{"brisk":"bin.js"},"engines":{"node":">=10.0.0"},"preconstruct":{"entrypoints":[".","handle-config"]},"dependencies":{"@atlaskit/breadcrumbs":"^8.0.0","@atlaskit/button":"^8.2.4","@atlaskit/code":"^9.0.0","@atlaskit/css-reset":"^3.0.5","@atlaskit/drawer":"^2.7.1","@atlaskit/dynamic-table":"^13.5.0","@atlaskit/icon":"^16.0.1","@atlaskit/navigation-next":"^4.1.2","@atlaskit/quick-search":"^5.2.5","@atlaskit/section-message":"^4.1.1","@atlaskit/table-tree":"^7.1.2","@atlaskit/theme":"^6.0.0","@atlaskit/tree":"^4.1.11","@atlaskit/width-detector":"^0.3.1","@babel/plugin-proposal-class-properties":"^7.3.4","@babel/preset-react":"^7.0.0","@babel/runtime":"^7.4.3","@brisk-docs/file-viewer":"^0.2.4","@brisk-docs/react-changelogs":"^0.1.10","@emotion/core":"^10.0.9","@emotion/styled":"^10.0.9","@mdx-js/loader":"^0.17.5","@mdx-js/mdx":"^1.0.0","@mdx-js/react":"^1.5.0","@reach/router":"^1.2.1","babel-loader":"^8.0.5","babel-plugin-transform-dynamic-import":"^2.1.0","babel-plugin-transform-flow-strip-types":"^6.22.0","command-line-args":"^5.0.2","emotion":"^9.1.3","emotion-server":"^9.2.12","extract-react-types-loader":"^0.3.7","filenamify":"^4.0.0","fs-extra":"^7.0.1","gatsby":"^2.15.28","gatsby-plugin-emotion":"^2.0","gatsby-plugin-manifest":"^2.2.26","gatsby-plugin-mdx":"^1.0.46","gatsby-plugin-page-creator":"^2.1.23","gatsby-plugin-react-helmet":"^3.1.10","gatsby-plugin-styled-components":"^3.1.8","gatsby-plugin-typescript":"^2.1.11","gatsby-source-filesystem":"^2.1.28","git-url-parse":"^11.1.2","glob":"^7.1.3","jest-fixtures":"^0.6.0","js-yaml":"^3.13.1","lodash.capitalize":"^4.2.1","lodash.debounce":"^4.0.8","lodash.flatten":"^4.4.0","lodash.identity":"^3.0.0","lodash.snakecase":"^4.1.1","outdent":"^0.7.0","pkg-dir":"^4.2.0","pretty-proptypes":"^0.6.6","prismjs":"^1.15.0","prop-types":"^15.6.2","raw-loader":"^1.0.0","react":"16.10.2","react-addons-text-content":"^0.0.4","react-dom":"^16.8.4","react-helmet":"^5.2.1","remark-frontmatter":"^1.3.2","remark-parse":"^6.0.3","title-case":"^2.1.1","unified":"^7.1.0","unist-util-visit":"^1.3.0"},"devDependencies":{"@atlaskit/avatar":"^17.1.3","@atlaskit/dropdown-menu":"^6.1.26","@types/fs-extra":"^8.0.0","enzyme":"^3.9.0","enzyme-adapter-react-16":"^1.9.1","mock-fs":"^4.10.1","styled-components":"^3.2.6"},"peerDependencies":{"styled-components":"^3.2.6"},"_id":"@brisk-docs/gatsby-generator@1.0.1","_npmVersion":"6.4.1","_nodeVersion":"10.13.0","_npmUser":{"name":"noviny","email":"benjaminconolly@gmail.com"},"dist":{"integrity":"sha512-7z7TKeN8eObow4D0o5Go1LKatI9yRsseayOXt/nae+4dHNkGAj+otPCSyHKpMqtHcZBhLUiZv2VYdQgPF0XuvQ==","shasum":"5054a8fdeea013e1a2843109bf17f7341d5c5410","tarball":"https://registry.npmjs.org/@brisk-docs/gatsby-generator/-/gatsby-generator-1.0.1.tgz","fileCount":117,"unpackedSize":1095456,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdxNT2CRA9TVsSAnZWagAAWdwP/0bxDni2OTITbsa8uxkh\nsvSSApMsOOfQDI5KBN6gImtKbjneTrCJIwmli9qLOqd09MLslFwLKjwonp1O\nhOvGm4pQKts0SWdKh5MlgpQZkAsgvqZTVNkJmCSqyTHhoJtBt/Y0GZH+rFzb\nQo5DHaalHMyxagizKEWP/YPfK/R6CIaJBHYDH554DeSROPNzx716y8WVZiD+\nZ9z6AX2VIO8aNgh/NJoaiyoWnLjE8VhOLl/6X7F/xgjrld4XlO04+NXIrdRQ\nqVbdFdKyzdaGLnuCd8m/2VC4iytzyjttKDQoVGuDG2Ts52U/XsRsRbeGtZ/Y\n8JQtSxlyjjicuNRe46elxrB6I3C03JRSuGdwYIE7MYMA/7jCU6TGubvhUoEu\nby6+mMvHLcZ+edDUp6tRGTKCZjfTF/EFcAOwm4b5Yhx9LBurlkgXrgoRaYCS\n+LfKug+yq75ya6wmhqmth+3R3q1WGDCMJbqPcVGysvHCq2A24VZ+Hhj4vOD1\nw9BKfET3SwwqQdaGsu/sIsnmkukktSvYpGWcqwEnflg7CnQwmTK0SxDAnYy8\nNDlMOLsrnYI3eC4fqvpOY0E1NcSUvWNmFNoRKKIy/u9VwhAZv+Et0DaUvuN7\np6tjDfvv3AQzrBQMhgIyiMlKbVKT7VZsvCeYJiESnXVLG12sLCYwusEPGSIF\nHEKF\r\n=c+Gt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDvCyOQ8FsuBZS1c1dtT7IeXj8nmLg7rK4o9zrC+Zl78AIgKxXIaLvQdrnwZ+WUR7r1LUVfczfFFWClGgUq8dfQyU0="}]},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gatsby-generator_1.0.1_1573180661570_0.6222463322471976"},"_hasShrinkwrap":false},"1.1.0":{"name":"@brisk-docs/gatsby-generator","version":"1.1.0","description":"The Brisk website documenter","main":"dist/gatsby-generator.cjs.js","module":"dist/gatsby-generator.esm.js","maintainers":[{"name":"dpisani-atl","email":"dpisani@atlassian.com"},{"name":"noviny","email":"benjaminconolly@gmail.com"}],"license":"MIT","scripts":{"dev":"node bin.js dev --config=dummy-data/simple-project/docs.config.js","dev:complete":"node bin.js dev --config=dummy-data/complete-config-project/docs.config.js","dev:webpack":"node bin.js dev --config=dummy-data/custom-webpack-project/docs.config.js","build:site":"node bin.js build --config=dummy-data/simple-project/docs.config.js","build:site:complete":"node bin.js build --config=dummy-data/complete-config-project/docs.config.js","export:site":"node bin.js export --config=dummy-data/simple-project/docs.config.js","build":"echo no build set yet for website","start":"node bin.js start","start:complete":"node bin.js dev --config=dummy-data/complete-config-project/docs.config.js"},"bin":{"brisk":"bin.js"},"engines":{"node":">=10.0.0"},"preconstruct":{"entrypoints":[".","handle-config"]},"dependencies":{"@atlaskit/breadcrumbs":"^8.0.0","@atlaskit/button":"^8.2.4","@atlaskit/code":"^9.0.0","@atlaskit/css-reset":"^3.0.5","@atlaskit/drawer":"^2.7.1","@atlaskit/dynamic-table":"^13.5.0","@atlaskit/icon":"^16.0.1","@atlaskit/navigation-next":"^4.1.2","@atlaskit/quick-search":"^5.2.5","@atlaskit/section-message":"^4.1.1","@atlaskit/table-tree":"^7.1.2","@atlaskit/theme":"^6.0.0","@atlaskit/tree":"^4.1.11","@atlaskit/width-detector":"^0.3.1","@babel/plugin-proposal-class-properties":"^7.3.4","@babel/preset-react":"^7.0.0","@babel/runtime":"^7.4.3","@brisk-docs/file-viewer":"^0.2.5","@brisk-docs/react-changelogs":"^0.1.11","@emotion/core":"^10.0.9","@emotion/styled":"^10.0.9","@mdx-js/loader":"^0.17.5","@mdx-js/mdx":"^1.0.0","@mdx-js/react":"^1.5.0","@reach/router":"^1.2.1","babel-loader":"^8.0.5","babel-plugin-transform-dynamic-import":"^2.1.0","babel-plugin-transform-flow-strip-types":"^6.22.0","command-line-args":"^5.0.2","emotion":"^9.1.3","emotion-server":"^9.2.12","extract-react-types-loader":"^0.3.7","filenamify":"^4.0.0","fs-extra":"^7.0.1","gatsby":"^2.17.10","gatsby-plugin-emotion":"^2.0","gatsby-plugin-manifest":"^2.2.26","gatsby-plugin-mdx":"^1.0.46","gatsby-plugin-page-creator":"^2.1.23","gatsby-plugin-react-helmet":"^3.1.10","gatsby-plugin-styled-components":"^3.1.8","gatsby-plugin-typescript":"^2.1.11","gatsby-source-filesystem":"^2.1.28","git-url-parse":"^11.1.2","glob":"^7.1.3","jest-fixtures":"^0.6.0","js-yaml":"^3.13.1","lodash.capitalize":"^4.2.1","lodash.debounce":"^4.0.8","lodash.flatten":"^4.4.0","lodash.identity":"^3.0.0","lodash.snakecase":"^4.1.1","outdent":"^0.7.0","pkg-dir":"^4.2.0","pretty-proptypes":"^0.6.6","prismjs":"^1.15.0","prop-types":"^15.6.2","raw-loader":"^1.0.0","react":"16.10.2","react-addons-text-content":"^0.0.4","react-dom":"^16.8.4","react-helmet":"^5.2.1","remark-frontmatter":"^1.3.2","remark-parse":"^6.0.3","title-case":"^2.1.1","unified":"^7.1.0","unist-util-visit":"^1.3.0"},"devDependencies":{"@atlaskit/avatar":"^17.1.3","@atlaskit/dropdown-menu":"^6.1.26","@types/fs-extra":"^8.0.0","enzyme":"^3.9.0","enzyme-adapter-react-16":"^1.9.1","mock-fs":"^4.10.1","styled-components":"^3.2.6"},"peerDependencies":{"styled-components":"^3.2.6"},"_id":"@brisk-docs/gatsby-generator@1.1.0","_npmVersion":"6.4.1","_nodeVersion":"10.13.0","_npmUser":{"name":"noviny","email":"benjaminconolly@gmail.com"},"dist":{"integrity":"sha512-gnVVNNOXqfsP7wFsHbwLNcTxcfJWotmvJasd1zCdhFMCXT89BJ2P7LXXBAlcEErh2qCkM9HZSSd2aPfaRLVosg==","shasum":"ee8fc8e174d74dbccfcebdb3f916deada0f2d432","tarball":"https://registry.npmjs.org/@brisk-docs/gatsby-generator/-/gatsby-generator-1.1.0.tgz","fileCount":107,"unpackedSize":350949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd0zH4CRA9TVsSAnZWagAARmQP/2Qqwxt2GIP/Toy/yXZP\nUGm7SKR9e6OsQRnc+T0iagP2WiM1iPwwujoZIKflW3NmPoxn8TkNc0YM3xZ9\nH0LLGgKzVFl18XUZWTXInAKVNZBfhXf6AQPOso2NfJs77seqnTBMQTb33DC7\nWSUph2B7ssm7apOJAMVu/VgarAVJK1EB7Sd7bPUfDLK2mENtJ/XngdSFMLWU\nuYEuzvDEc4zjSsPEy72YYIrZBVaNl9nzOXQk7Xfp1D8+s2lrtnTD7qoJOvHf\n0vOSyeh9c3C3LatiU+rFQPPJdBqS2ZpkVLrnHI2GTOQu227fc4YaQbYD2F7w\nFY6gd2oJHp7j/W2zQY1VZRBGIgO172jbVwB8sUYMSsoC0EslTXY2/7+3b5gW\nU4JVDbv6Lfl3fjfX45T85jsK/9MQCGQw9wzcFnb/twdtVquJdyFyPkoTsA1G\nAnkqGS2wlDPQpfxxPnPY1cx24OfV7dOh8ZgdwkC/tJS5Q/uJrNQVJ/qXrO+8\nJRz9obSA7B5rVA5pabtBQO9fEE0DNpUhegUaRylK1hJmz+QNhrUCoVOPzzPM\ny2QWnfHu2e219y3ohWls+ALypA+9Z207fPKZVTlGUnO00vgBupY9ZzE44USg\nXEGw3VYbozEr6V7YdrK9G0glU0lMW+MVzv49ZKY75YLIu3P5oEexrjsJNgl9\nLzK7\r\n=Q386\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBZ0/DLNMK3TRW429miwsL0Je9oABwd+cq6ArtUIIR6eAiEA3TW3foIEwKkbCpj4USQrhUr+cJlKChzTF4J9VrTq79E="}]},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/gatsby-generator_1.1.0_1574121976158_0.35252141327682973"},"_hasShrinkwrap":false}},"time":{"created":"2019-11-04T23:37:44.598Z","1.0.0":"2019-11-04T23:37:45.000Z","modified":"2022-04-04T20:42:22.538Z","1.0.1":"2019-11-08T02:37:41.711Z","1.1.0":"2019-11-19T00:06:16.407Z"},"maintainers":[{"name":"dpisani-atl","email":"dpisani@atlassian.com"},{"name":"noviny","email":"benjaminconolly@gmail.com"}],"description":"The Brisk website documenter","license":"MIT","readme":"# Brisk Docs website generator\n\nBrisk Docs is a package oriented documentation system that lets you write useful, interactive\ndocs alongside your code. It is aimed at documenting packages in a mono-repo\n\n## Getting started\n\nStart by installing Brisk Docs in your project\n\n```\nnpm install @brisk-docs/website\n```\n\nTo start your docs website locally:\n\n```\nnpm run brisk dev\n```\n\nTo produce a static build of the website that can be statically hosted:\n\n```\nnpm run brisk build && npm run brisk export\n```\n\n## Organising your documentation\n\nBrisk Docs by default uses file and folder name conventions to find docs in your codebase and display them in a organised way.\n\n### Project level documentation\n\nFor guides and docs relating to your project or repository as a whole, Brisk Docs will display any Markdown or [MDX](https://mdxjs.com/) files placed in the `/docs` folder at the top of your repository. This is a good place to put user guides, tutorials, contributor guidelines etc.\n\n### Package level documentation\n\nBrisk Docs has first class support for multi-package repos. All packages found in the `/packages` directory of your project will have documentation generated automatically.\n\nRead more about package documentation in our [package documentation guide.](./docs/writing-package-docs.md)\n\n## Using MDX\n\nMDX means that we parse markdown a little differently, and treat jsx blocks as react components.\n\nThis means that you can write:\n\n```mdxjs\n# Just a regular markdown package\n\nimport MyComponent from './src/myComponent'\n\n<MyComponent>I could not be expressed just with markdown<.MyComponent>\n\nJust some more _regular_ markdown here.\n```\n\nIn addition to being able to render any markdown, brisk provides two components that can be used on any\npage without being imported.\n\nThey are `<Props />` and `<FileViewer />` - these are exports of [pretty-proptypes](https://github.com/atlassian/extract-react-types/tree/master/packages/pretty-proptypes) and [file-viewer](../../packages/file-viewer)\n","readmeFilename":"README.md"}