react-okr-ui
Version:
A React user interface toolkit for building OKR centric applications.
1 lines • 7.96 kB
JSON
{"expireTime":9007200867386061000,"key":"gatsby-plugin-mdx-entire-payload-f39767701327fdf8bf0561af9580b110-","val":{"mdast":{"type":"root","children":[{"type":"import","value":"import DefaultLayout from \"/Users/seanrioux/products/open-source-okr/code/react-okr-ui/node_modules/gatsby-theme-docz/src/base/Layout.js\"","position":{"start":{"line":3,"column":1,"offset":2},"end":{"line":3,"column":138,"offset":139},"indent":[]}},{"type":"export","default":true,"value":"export default DefaultLayout","position":{"start":{"line":5,"column":1,"offset":141},"end":{"line":5,"column":29,"offset":169},"indent":[]}},{"type":"heading","depth":1,"children":[{"type":"text","value":"Contribution guide","position":{"start":{"line":8,"column":3,"offset":174},"end":{"line":8,"column":21,"offset":192},"indent":[]}}],"position":{"start":{"line":8,"column":1,"offset":172},"end":{"line":8,"column":21,"offset":192},"indent":[]}},{"type":"heading","depth":2,"children":[{"type":"text","value":"Git","position":{"start":{"line":10,"column":4,"offset":197},"end":{"line":10,"column":7,"offset":200},"indent":[]}}],"position":{"start":{"line":10,"column":1,"offset":194},"end":{"line":10,"column":7,"offset":200},"indent":[]}},{"type":"paragraph","children":[{"type":"text","value":"Contributors should work from the latest version branch in development (indicated using format ","position":{"start":{"line":12,"column":1,"offset":202},"end":{"line":12,"column":96,"offset":297},"indent":[]}},{"type":"inlineCode","value":"v0.1.0","position":{"start":{"line":12,"column":96,"offset":297},"end":{"line":12,"column":104,"offset":305},"indent":[]}},{"type":"text","value":").","position":{"start":{"line":12,"column":104,"offset":305},"end":{"line":12,"column":106,"offset":307},"indent":[]}}],"position":{"start":{"line":12,"column":1,"offset":202},"end":{"line":12,"column":106,"offset":307},"indent":[]}},{"type":"paragraph","children":[{"type":"text","value":"Pull requests will be reviewed for contribution to future releases.","position":{"start":{"line":14,"column":1,"offset":309},"end":{"line":14,"column":68,"offset":376},"indent":[]}}],"position":{"start":{"line":14,"column":1,"offset":309},"end":{"line":14,"column":68,"offset":376},"indent":[]}},{"type":"heading","depth":2,"children":[{"type":"text","value":"Development","position":{"start":{"line":16,"column":4,"offset":381},"end":{"line":16,"column":15,"offset":392},"indent":[]}}],"position":{"start":{"line":16,"column":1,"offset":378},"end":{"line":16,"column":15,"offset":392},"indent":[]}},{"type":"paragraph","children":[{"type":"text","value":"The easiest way to get started is via the included Docz site. Docz is a React based static site generator for documentation. It uses mdx.","position":{"start":{"line":18,"column":1,"offset":394},"end":{"line":18,"column":138,"offset":531},"indent":[]}}],"position":{"start":{"line":18,"column":1,"offset":394},"end":{"line":18,"column":138,"offset":531},"indent":[]}},{"type":"paragraph","children":[{"type":"text","value":"Using Docz we have components in a living style guide. To run Docz locally for development:","position":{"start":{"line":20,"column":1,"offset":533},"end":{"line":20,"column":92,"offset":624},"indent":[]}}],"position":{"start":{"line":20,"column":1,"offset":533},"end":{"line":20,"column":92,"offset":624},"indent":[]}},{"type":"code","lang":null,"meta":null,"value":"npm install\nnpm run docz:dev","position":{"start":{"line":22,"column":1,"offset":626},"end":{"line":25,"column":4,"offset":662},"indent":[1,1,1]}},{"type":"paragraph","children":[{"type":"text","value":"To run a build of the Docz site:","position":{"start":{"line":27,"column":1,"offset":664},"end":{"line":27,"column":33,"offset":696},"indent":[]}}],"position":{"start":{"line":27,"column":1,"offset":664},"end":{"line":27,"column":33,"offset":696},"indent":[]}},{"type":"code","lang":null,"meta":null,"value":"npm run docz:build","position":{"start":{"line":29,"column":1,"offset":698},"end":{"line":31,"column":4,"offset":724},"indent":[1,1]}},{"type":"paragraph","children":[{"type":"text","value":"To build and serve a Docz site:","position":{"start":{"line":33,"column":1,"offset":726},"end":{"line":33,"column":32,"offset":757},"indent":[]}}],"position":{"start":{"line":33,"column":1,"offset":726},"end":{"line":33,"column":32,"offset":757},"indent":[]}},{"type":"code","lang":null,"meta":null,"value":"npm run docz:serve","position":{"start":{"line":35,"column":1,"offset":759},"end":{"line":37,"column":4,"offset":785},"indent":[1,1]}},{"type":"heading","depth":2,"children":[{"type":"text","value":"Build","position":{"start":{"line":39,"column":4,"offset":790},"end":{"line":39,"column":9,"offset":795},"indent":[]}}],"position":{"start":{"line":39,"column":1,"offset":787},"end":{"line":39,"column":9,"offset":795},"indent":[]}},{"type":"paragraph","children":[{"type":"text","value":"Builds for distribution are via Webpack. To test your builds, you can:","position":{"start":{"line":41,"column":1,"offset":797},"end":{"line":41,"column":71,"offset":867},"indent":[]}}],"position":{"start":{"line":41,"column":1,"offset":797},"end":{"line":41,"column":71,"offset":867},"indent":[]}},{"type":"code","lang":null,"meta":null,"value":"npm run build","position":{"start":{"line":43,"column":1,"offset":869},"end":{"line":45,"column":4,"offset":890},"indent":[1,1]}},{"type":"paragraph","children":[{"type":"text","value":"Builds are distributed via npm.","position":{"start":{"line":47,"column":1,"offset":892},"end":{"line":47,"column":32,"offset":923},"indent":[]}}],"position":{"start":{"line":47,"column":1,"offset":892},"end":{"line":47,"column":32,"offset":923},"indent":[]}},{"type":"export","value":"export const _frontmatter = {}","position":{"start":{"line":50,"column":1,"offset":926},"end":{"line":50,"column":31,"offset":956},"indent":[]}}],"position":{"start":{"line":1,"column":1,"offset":0},"end":{"line":50,"column":31,"offset":956}}},"scopeImports":[],"scopeIdentifiers":[],"rawMDXOutput":"/* @jsx mdx */\nimport { mdx } from '@mdx-js/react';\n/* @jsxRuntime classic */\n/* @jsx mdx */\nimport DefaultLayout from \"/Users/seanrioux/products/open-source-okr/code/react-okr-ui/node_modules/gatsby-theme-docz/src/base/Layout.js\"\nexport const _frontmatter = {};\n\nconst layoutProps = {\n _frontmatter\n};\nconst MDXLayout = DefaultLayout\nexport default function MDXContent({\n components,\n ...props\n}) {\n return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n\n\n <h1 {...{\n \"id\": \"contribution-guide\"\n }}>{`Contribution guide`}</h1>\n <h2 {...{\n \"id\": \"git\"\n }}>{`Git`}</h2>\n <p>{`Contributors should work from the latest version branch in development (indicated using format `}<inlineCode parentName=\"p\">{`v0.1.0`}</inlineCode>{`).`}</p>\n <p>{`Pull requests will be reviewed for contribution to future releases.`}</p>\n <h2 {...{\n \"id\": \"development\"\n }}>{`Development`}</h2>\n <p>{`The easiest way to get started is via the included Docz site. Docz is a React based static site generator for documentation. It uses mdx.`}</p>\n <p>{`Using Docz we have components in a living style guide. To run Docz locally for development:`}</p>\n <pre><code parentName=\"pre\" {...{}}>{`npm install\nnpm run docz:dev\n`}</code></pre>\n <p>{`To run a build of the Docz site:`}</p>\n <pre><code parentName=\"pre\" {...{}}>{`npm run docz:build\n`}</code></pre>\n <p>{`To build and serve a Docz site:`}</p>\n <pre><code parentName=\"pre\" {...{}}>{`npm run docz:serve\n`}</code></pre>\n <h2 {...{\n \"id\": \"build\"\n }}>{`Build`}</h2>\n <p>{`Builds for distribution are via Webpack. To test your builds, you can:`}</p>\n <pre><code parentName=\"pre\" {...{}}>{`npm run build\n`}</code></pre>\n <p>{`Builds are distributed via npm.`}</p>\n\n </MDXLayout>;\n}\n\n;\nMDXContent.isMDXComponent = true;"}}