Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@sanity/block-content-to-markdown
Advanced tools
Render an array of block text from Sanity to markdown.
Note: Currently in beta - please leave us feedback :)
npm install --save @sanity/block-content-to-markdown
const toMarkdown = require('@sanity/block-content-to-markdown')
const client = require('@sanity/client')({
projectId: '<your project id>',
dataset: '<some dataset>',
useCdn: true
})
const serializers = {
types: {
code: props => '```' + props.node.language + '\n' + props.node.code + '\n```'
}
}
client.fetch('*[_type == "article"][0]').then(article => {
console.log(toMarkdown(article.body, {serializers}))
})
serializers
- Specifies the functions used for rendering content. Merged with default serializers.serializers.types
- Serializers for block types, see example aboveserializers.marks
- Serializers for marks - data that annotates a text child of a block. See example usage below.serializers.list
- Function to use when rendering a list nodeserializers.listItem
- Function to use when rendering a list item nodeserializers.hardBreak
- Function to use when transforming newline characters to a hard breakimageOptions
- When encountering image blocks, this defines which query parameters to apply in order to control size/crop mode etc.In addition, in order to render images without materializing the asset documents, you should also specify:
projectId
- The ID of your Sanity project.dataset
- Name of the Sanity dataset containing the document that is being rendered.const input = [
{
_type: 'block',
children: [
{
_key: 'a1ph4',
_type: 'span',
marks: ['s0m3k3y'],
text: 'Sanity'
}
],
markDefs: [
{
_key: 's0m3k3y',
_type: 'highlight',
color: '#E4FC5B'
}
]
}
]
const highlight = props => {
const content = Array.isArray(props.children) ? props.children.join('') : props.children
return `<span style="background-color: ${props.mark.color};">${content}</span>`
}
toMarkdown(input, {serializers: {marks: {highlight}}})
toMarkdown(input, {
imageOptions: {w: 320, h: 240, fit: 'max'},
projectId: 'myprojectid',
dataset: 'mydataset'
})
MIT-licensed. See LICENSE.
FAQs
Transforming Sanity block content to markdown
The npm package @sanity/block-content-to-markdown receives a total of 2,377 weekly downloads. As such, @sanity/block-content-to-markdown popularity was classified as popular.
We found that @sanity/block-content-to-markdown demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.