{"id":20373358,"url":"https://github.com/frontarm/doc","last_synced_at":"2026-02-05T22:04:17.736Z","repository":{"id":33788387,"uuid":"161471188","full_name":"frontarm/doc","owner":"frontarm","description":"A set of components for creating rich, responsive documents built around MDX.","archived":false,"fork":false,"pushed_at":"2022-02-26T02:39:56.000Z","size":4807,"stargazers_count":3,"open_issues_count":34,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-26T00:58:53.898Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frontarm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-12T10:24:10.000Z","updated_at":"2020-05-22T19:06:45.000Z","dependencies_parsed_at":"2022-08-07T23:01:15.096Z","dependency_job_id":null,"html_url":"https://github.com/frontarm/doc","commit_stats":null,"previous_names":["frontarm/document"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/frontarm/doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontarm%2Fdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontarm%2Fdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontarm%2Fdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontarm%2Fdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frontarm","download_url":"https://codeload.github.com/frontarm/doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frontarm%2Fdoc/sbom","scorecard":{"id":412094,"data":{"date":"2025-08-11","repo":{"name":"github.com/frontarm/doc","commit":"26ff34a3ce8216d895da391d43df2dd6e8c79ed0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.3,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/16 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":0,"reason":"162 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m","Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq","Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr","Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj","Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2","Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5","Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp","Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq","Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr","Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765","Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7","Warn: Project is vulnerable to: GHSA-c9g6-9335-x697","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-3329-pjwv-fjpg","Warn: Project is vulnerable to: GHSA-p6j9-7xhc-rhwp","Warn: Project is vulnerable to: GHSA-89gv-h8wf-cg8r","Warn: Project is vulnerable to: GHSA-gcv8-gh4r-25x6","Warn: Project is vulnerable to: GHSA-gmv4-r438-p67f","Warn: Project is vulnerable to: GHSA-8h2f-7jc4-7m3m","Warn: Project is vulnerable to: GHSA-3vjf-82ff-p4r3","Warn: Project is vulnerable to: GHSA-g694-m8vq-gv9h","Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v","Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442","Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc","Warn: Project is vulnerable to: GHSA-rqff-837h-mm52","Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2","Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j","Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-cf66-xwfp-gvc4","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h","Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp","Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c","Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9","Warn: Project is vulnerable to: GHSA-779f-wgxg-qr8f","Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264","Warn: Project is vulnerable to: GHSA-9v62-24cr-58cx","Warn: Project is vulnerable to: GHSA-r8f7-9pfq-mjmv","Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3","Warn: Project is vulnerable to: GHSA-wvhm-4hhf-97x9","Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w","Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg","Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96","Warn: Project is vulnerable to: GHSA-3949-f494-cm99","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-7mwh-4pqv-wmr8","Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx","Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T22:58:40.176Z","repository_id":33788387,"created_at":"2025-08-18T22:58:40.177Z","updated_at":"2025-08-18T22:58:40.177Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29135941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T21:59:57.939Z","status":"ssl_error","status_checked_at":"2026-02-05T21:59:57.628Z","response_time":65,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T01:17:59.550Z","updated_at":"2026-02-05T22:04:17.718Z","avatar_url":"https://github.com/frontarm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"@frontarm/doc\n==================\n\n\u003e A set of components for creating rich, responsive documents built around MDX.\n\n[![NPM](https://img.shields.io/npm/v/@frontarm/doc.svg)](https://www.npmjs.com/package/@frontarm/doc) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n## Install\n\n```bash\nnpm install --save @frontarm/doc\n```\n\n\nDesign notes\n-----\n\n- Styles are designed with the assumption that there'll be 250px of sidebar on windows with width of 1101px or up.\n\n- This library is pretty raw, and you can break things by messing with the styles on\n  blocks, asides, and gutters. Unfortunately, you need can't escape messing with the styles on blocks.\n  so think of this more as a shitty but useful tool for creating websites with documents with a\n  two-column layout -- not a self-contained library that is useful for specifying documents without\n  any other work. You *will* probably need to use media queries in your theme. You *will* need to\n  be careful of your use of \"margin\". Global margin styles *will* make your life miserable.\n  \n\nMain Components\n---------------\n\n### `\u003cDoc\u003e`\n\nExpects an MDX component as its `MDXComponent` prop.\n\nLike MDX components, the components that are used to render each type of Document component can be configured, either by passing in a `components` object to your `\u003cDoc\u003e` component, or by using a `\u003cDocProvider\u003e` component.\n\n#### `props\n\n- `MDXComponent`\n\n  The MDX Document component to render.\n\n- `props?: any`\n\n  Props that will be passed through to the rendered MDXComponent\n\n- `demoboardHelpers?: { [name: string]: string }`\n\n  Helper files that will be available to all inline demoboards\n\n- `canAccessRestrictedContent?: boolean`\n\n  If true, any editors/videos with the `isRestricted` attribute will be usable\n\n- `isStatic?: boolean`\n\n  If true, any nested `\u003cHideWhenStatic\u003e` blocks will not be shown.\n\n\n### `\u003cDocProvider components children\u003e`\n\nMerges in default values for the `components` object of any child `\u003cComponent\u003e` elements.\n\n\nContent Components\n------------------\n\n### `\u003cBeware children title=\"Beware\"\u003e`\n\nIndicates content that helps the reader from hurting themselves or losing a large amount of time.\n\nAssumes placement within the left column.\n\n### `\u003cDemoboard ...\u003e`\n\nRenders an inline demoboard.\n\n#### `props`\n\n- `persistenceKey`\n\n  If present, any changes will be saved for each user, and loaded when the user navigates back to the page. This key will not be visible to the user, and should be unique across the entire site. It should follow the format `path#keyWithinPage`. A warning will be logged if the path doesn't map to the current path, or if multiple keys are used on the same page.\n\n- `restricted`\n\n  If true, readers won't be able to use the demoboard unless `canAccessRestrictedContent` is also passed to the parent `\u003cDocument\u003e` element.\n\n- `sources`\n\n  Accepts a list of sources, with magic sources prefixed by `magic:`, and solution sources prefixed by `solution:`.\n\n  *Future plan: create a loader that allows an entire directory to be smashed in here with a single `require()`...*\n\n- `theme?: \"dark\" | \"light\"`\n\n- `maximizeLeftPanel?: boolean`: *defaults to `true`*\n- `maximizeRightPanel?: boolean`: *defaults to `false`*\n- `leftPanel?: 'transformedSource' | 'solutionSource'`\n- `lineCount?: number`\n- `rightPanel?: 'console'`\n- `tab?: 'editor' | 'viewer'`\n\n### `\u003cDetails children title=null\u003e`\n\nCan be placed in either the left or right columns.\n\n### `\u003cSpoiler children title=\"Spoiler\"\u003e`\n\nAssumes placement within the left column.\n\n### `\u003cTangent children title=null\u003e`\n\nAssumes placement within the right column.\n\n### `\u003cVideo ...\u003e`\n\nCan be placed anywhere; the left column, right column, both columns or full width are all allowable.\n\n#### `props`\n\n- `TODO`\n\n- `restricted`\n\n  If true, readers won't be able to use the demoboard unless `canAccessRestrictedContent` is also passed to the parent `\u003cDocument\u003e` element.\n\n\nLayout Components\n-----------------\n\nLayout components are not configurable\n\n### `\u003cDoc.Block children\u003e`\n\nRenders a block of content in the left column.\n\n### `\u003cDoc.Aside children\u003e`\n\nFloats a block of content right of the following columns, similar to how floats in CSS work, but\ncan be raise up to the position of the top of the wrapping `\u003cAsideTop\u003e` div.\n\n```\nTODO: format this info better:\n\n\n\"Block\" (gutterless?):\n\n- center align on single column\n- left align on twin column\n- add a gutter (i.e. minimum left/right spacing around the element) if one isn't specified around it,\n  unless \"gutterless?\" is specified.\n- can *not* have margins added to it, as content needs to have left/right margin of \"auto\"\n  to accomodate horizontal centering without a container, which would (I think) break floated asides\n  and full width stuff\n\n\n\"Aside\"/\"Float\":\n\n- will center align on single column, with extra spacing compared to \"Block\" to accomodate a gutter\n- will float right on twin column\n- can only have margins added to it when not centered.\n\n  - nested \"Block\" will have a gutter added, but it can be wrapped in other\n    styles and have margins added\n\n\n\"Gutter\" (half?) (left?) (right?):\n\n- add a minimum left/right spacing around the element\n- can not have margins added to it\n- is useful for adding spacing around full-width and aside elements \n\n  - nested \"Block\" will have its gutter replaced by this block\n```\n\n\nConditional Rendering Components\n--------------------------------\n\n### `\u003cDoc.HideWhenStatic children\u003e`\n\nHides its children when the document is being statically built -- useful for parts of the document that vary between guest and pro members.\n\n### `\u003cDoc.Restricted restricted? children\u003e`\n\nShow the children only when the viewer has full access to the Doc. If the viewer doesn't have full access, show the `restricted` element instead.\n\n\nCode blocks\n-----------\n\nWhen Markdown code blocks begin with the line `//---`, they'll be turned into `\u003cDoc.Demoboard\u003e` elements. Otherwise, they'll be treated as code listings, which are rendered with the standard `codeBlock` component.\n\nDemoboard code blocks will be split into sections denoted by `//---`. The first section contains configuration that will be passed as props to the `\u003cDoc.Demoboard\u003e` component. The following sections will be treated differently depending on how they start:\n\n- `--- filename`\n\n  Treats the following lines as a source file with the specified filename\n\n- `--- filename \u003c-- helperFilename`\n\n  Creates a file, solution or magic file from the helper with the given name.\n\n### Example\n\n```jsx\n//---\n// name: \"Demoboard name\"\n// description: \"Some description about this demoboard\"\n// isRestricted: true // if true, this will be hidden unless \n// defaultRightPanel: \"console\"\n// consoleIsMaximized: false\n// defaultViewerURL: ''\n//--- main.js\nconst isDone = false\n//--- helper:main.js\nconst isDone = true\n//--- magic:package.json\n{\n  name: \"magicFile\",\n  description: \"built but not displayed in tabs\"\n}\n//--- styles.css \u003c-- styles-a.css\n.test {\n  /**\n   * Helpers allow files to be shared between demoboards\n   */\n}\n```\n\nNote that while this inline syntax is great for small, quick examples, for bigger examples you might find it easier to manually add a `\u003cDoc.Demoboard\u003e` element.\n\n\n`components` object\n-------------------\n\nThe `components` object can be passed to an individual `\u003cDocument\u003e`, or can be passed to a `\u003cDocumentProvider\u003e` to set the default components for all child documents. It supports all MDX compnents, along with a number of document-specific components.\n\n- `\u003cwrapper\u003e`\n\n  Like the MDX `wrapper` component, but also receives any `className`, `style` and `id` that were passed to the `\u003cDocument\u003e` element itself.\n\n- `\u003cheadingLink href\u003e`\n\n  A link within heading elements that points to the heading itself.\n\n\n### Content components\n\n- `Beware`\n- `Demoboard`: *also includes a `hasAccess` boolean*\n- `Details`\n- `Spoiler`\n- `Tangent`\n- `Video`: *also includes a `hasAccess` boolean*\n\n\n\n## License\n\nMIT © [James K Nelson](https://frontarm.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontarm%2Fdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrontarm%2Fdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontarm%2Fdoc/lists"}