Comments (6)
@StarpTech can you share a snippet of what your Markdoc content looks like, as well as how you are registering the Image
component (the file under your markdoc/
folder)?
It would be great if you could share a full reproduction of things like this 🙂
from markdoc.
FYI: It worked with a span
as container element.
// markdoc/nodes/image.markdoc.ts
import { Image } from '../../src/components/blog/Image'
import { Tag } from '@markdoc/markdoc'
export const image = {
render: Image,
attributes: {
src: { type: String },
alt: { type: String }
},
transform(node: any, config: any) {
const attributes = node.transformAttributes(config)
const children = node.transformChildren(config)
// @ts-ignore
return new Tag(this.render, { ...attributes }, children)
},
}
// src/components/blog/Image.tsx
export function Image({
src,
alt
}: {
src: string
alt: string
}) {
return (
<div
>
<NextImage
src={src}
alt={alt}
width="100px"
height="100px"
/>
</div>
)
}
Usage:
![altText](URL)
from markdoc.
This is expected, as ![altText](URL)
in the Markdown spec creates an inline element, which according to the spec should be nested within a p
tag. This is why when you render a span
instead of a div
, the error goes away.
If you want to use a block level image, I would suggest creating an image
Tag, which would be used like:
{% image src="/" alt="Alt tag" /%}
Then you could render a div
in your Image
component.
from markdoc.
I have fixed it very similar but this destroys the benefit of using just markdown.
from markdoc.
import { Tag } from '@markdoc/markdoc'
export const paragraph = {
transform: (node: any, config: any) => {
const attributes = node.transformAttributes(config)
const children = node.transformChildren(config)
// hack to make rendering block tags work correctly. They shouldn't be wrapped in a p tag.
if (children.length === 1 && children[0] instanceof Tag) {
return children
}
return new Tag('p', attributes, children)
},
}
I had to hack the paragraph node to make sure block Tags aren't rendered inside a p node.
from markdoc.
@Pagebakers our docs describe why some elements are wrapped in a p
tag here: https://markdoc.dev/docs/syntax#tags
from markdoc.
Related Issues (20)
- Markdoc language server extension fails to run in VS Code HOT 1
- Fetching markdoc props inside the next app router HOT 1
- Allow metadata export to be optional in markdoc/next.js
- html-nodejs example: document undefined error in Windows system, but same works in macOS
- `\n` in string attribute causes syntax error HOT 2
- allowIndentation docs are outdated HOT 3
- Table's width attribute throws type error on strings HOT 1
- Unclosed selfClosing tag vacuums everything after it in the page HOT 4
- Update Config types to account for Schema render function
- Attributes don't render on Cloudflare Workers (but work locally) HOT 1
- Render image with data URI (image/svg+xml) HOT 3
- Code fence doesn't pass through info string HOT 2
- Markdoc `module.exports` pattern not working with Next.js `14.1.0` HOT 5
- Website using markdoc getting crash randomly with TypeError: Cannot read properties of undefined (reading 'content') HOT 1
- `transform` should work with Promises but doesn't HOT 2
- Replace the Tag class by a POJO to make the RenderableTreeNode serializable HOT 3
- Exported `transform` type should return `MaybePromise`
- Being able to open links in a new tab
- Markdoc language server on a Next.js app
- Building markdoc docs fails with react 16-vs-18 incompatibility HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from markdoc.