How to use the remark function in remark

To help you get started, we’ve selected a few remark examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github phenomic / phenomic / src / loader-plugin-markdown-init-head.description-property-from-content / index.js View on Github external
function description(text, opts = {}) {
  opts = { ...defaultOpts, ...opts }

  if (opts.pruneLength === 0) {
    console.warn(
      "You defined 'description.pruneLength' of phenomic loader " +
      "with an zero value. This does not make sense, " +
      `so the default value ${ defaultOpts.pruneLength } has been used.`
    )

    opts.pruneLength = defaultOpts.pruneLength
  }

  return prune(
    remark()
      .use(stripMd)
      .process(text)
      .toString()
      .replace(/\n+/g, " ") // Avoid useless new lines
      .trim()
    ,
    opts.pruneLength,
    opts.pruneString
  )
}
github rhiokim / flybook / libs / md-loader.js View on Github external
// @flow
import fs from 'fs'
import remark from 'remark'
import html from 'remark-html'
import hljs from 'remark-highlight.js'
import slug from 'remark-slug'
import headding from 'remark-autolink-headings'

const app = remark()
app.use([slug, headding, html])

export default (file: string): string => {
  let markdown: string = fs.readFileSync(file).toString('utf8')
  const { contents } = app.processSync(markdown)

  return contents
}
github runtools / run / website / src / components / markdown.js View on Github external
render() {
    return remark()
      .use(remarkReactRenderer, {
        sanitize: sanitization,
        remarkReactComponents: {
          a: ({href, children}) => {
            if (href.match(/^https?:\/\//i) || href.startsWith('mailto:')) {
              // External Link
              return <a href="{href}">{children}</a>;
            }
            return {children};
          },
          code: ({className, children}) =&gt; {
            let language;
            if (className &amp;&amp; className.startsWith('language-')) {
              language = className.slice('language-'.length);
            }
            return <code>{children[0]}</code>;
github exokitxr / zeo / public / doc / src / components / section.js View on Github external
function renderHighlighted(nodes) {
  return {
    __html: postHighlight(remark()
      .use(remarkHTML)
      .stringify(remark()
        .use(remarkHighlight)
        .use(remarkPlugins)
        .runSync({
          type: 'root',
          children: nodes
        })))
  };
}
github Leko / hothouse / packages / hothouse / src / utils / md2html.js View on Github external
import remark from "remark";
import github from "remark-github";
import markdown from "remark-parse";
import html from "remark-html";

const pipeline = remark()
  .use(github)
  .use(markdown)
  .use(html);

export default (markdown: string): string =>
  pipeline.processSync(markdown).contents;
github JakeGinnivan / react-redux-notifications / lib / render.js View on Github external
export default function (rootPath, context, demoTemplate) {
  demoTemplate = demoTemplate || '';

  var readme = fs.readFileSync(
    path.join(rootPath, 'README.md'), 'utf8'
  );

  return {
    name: context.name,
    description: context.description,
    demonstration: demoTemplate,
    documentation: ReactDOM.renderToStaticMarkup(
      <div>
        {remark().use(reactRenderer, {
          remarkReactComponents: {
            code: RemarkLowlight({
              js
            })
          }
        }).process(readme)}
      </div>
    )
  };
}
github explosion / spaCy / website / src / components / util.js View on Github external
export function markdownToReact(markdown, remarkReactComponents = {}) {
    return remark()
        .use(remark2react, { remarkReactComponents })
        .processSync(markdown).contents
}
github wix / okidoc / packages / okidoc-md / src / buildMarkdown / buildMarkdownAST / renderHTML.js View on Github external
function renderHTML(node) {
  if (!node) {
    return '';
  }

  if (Array.isArray(node)) {
    node = u('root', node);
  }

  return remark()
    .use(remarkHtml)
    .stringify(node);
}
github janryWang / doc-scripts / src / webpack / markdown.js View on Github external
export const parseToc = async (text, traverse) => {
  const { contents } = await remark()
    .use(function() {
      this.Compiler = root => {
        return cleanTree(root, traverse)
      }
    })
    .process(text)

  return contents
}

remark

markdown processor powered by plugins part of the unified collective

MIT
Latest version published 8 months ago

Package Health Score

83 / 100
Full package analysis