faq
Faq
Questions and answers. Each `### heading` is a question and the Markdown under it is the answer. Bold the question people should read first. For a procedure, use Steps.
- use it
- Good for questions people keep asking, with the answer under each.
install
Each heading is a question. Everything under it, up to the next heading, is the answer — paragraphs, lists, code.
Is this an npm package?
No. The CLI copies the source into
registry/default. You own it.Does it need MDX?
No. Comark reads
::graph-*blocks from plain.md, and every figure has a fenced ASCII twin for GitHub.Why is my timeline empty?
Your
mdx-components.tsxswapslifor its own component. Wrap the map inwithMdxcn.
<Faq>
### Is this an npm package?
No. The CLI copies the source into `registry/default`. You own it.
### Does it need MDX?
No. Comark reads `::graph-*` blocks from plain `.md`, and every figure has a fenced ASCII twin for GitHub.
### **Why is my timeline empty?**
Your `mdx-components.tsx` swaps `li` for its own component. Wrap the map in `withMdxcn`.
</Faq>install
command
| Prop | Type | Default | Description |
|---|---|---|---|
| title | string | "faq" | Caption drawn on the top edge of the frame. |
| children | Markdown | — | Headings and the paragraphs, lists, or code under them. |
| entries | { question, answer?, accent? }[] | — | Data form. |
| palette | "mono" | "duo" | "multi" | "mono" | mono is one accent plus muted. duo paints the second series with --graph-accent-2. multi cycles three accents. |
| corner | string | "+" | Character at each corner of the frame. |
| frame | "box" | "corners" | "rule" | "none" | "box" | box draws the dashed border. corners keeps only the corner marks. rule draws dashed lines above and below. none drops the border and padding, and puts the title above the content. |
| className | string | — | Passed to the outer frame. |