Overview

Bare concepts to get started with understanding how to initialize a doc instance using unified-doc. More details and recipes are covered in further sections.

Render to HTML string

Simplest example of rendering any content into stringified HTML.

// import Doc from 'unified-doc';
function () {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  return <pre>{doc.compile().contents}</pre>
}

<blockquote>
<p><strong>some</strong> markdown content</p>
</blockquote>

Render to code block

For any content other than .html and .md, we will conveniently render to a code block useful for displaying source code with relevant syntax highlighting.

// import Doc from 'unified-doc';
function () {
  const doc = Doc({
    content: `
      function greet() {
        return "hello world";
      }`,
    filename: 'doc.js',
  });
  return <pre>{doc.compile().contents}</pre>
}

<pre><code>
      function greet() {
        return "hello world";
      }</code></pre>