Overview

The doc.file() method provides simple ways to return file data based on the specifie file extension (if supported). This is the unified-doc's way of performing file conversions!

Simple filename operations

With the returned file data, you can easily work with the filename and extension to rename files.

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });

  const fileData = doc.file();
  const { extension, name, stem, type } = fileData;
  const newExtension = '.new-extension';

  return (
    <div>
      <div>
        <strong>Old filename</strong>:{' '}
        <code>{name}</code>
      </div>
      <div>
        <strong>New filename</strong>:{' '}
        <code>{stem + newExtension}</code>
      </div>
    </div>
  );
}

// import Doc from 'unified-doc';
function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  const fileData = doc.file();
  const { extension, name, stem, type } = fileData;
  const newExtension = '.new-extension';
  return (
    <div>
      <div>
        <strong>Old filename</strong>:{' '}
        <code>{name}</code>
      </div>
      <div>
        <strong>New filename</strong>:{' '}
        <code>{stem + newExtension}</code>
      </div>
    </div>
  );
}

Preview

Old filename: doc.md

New filename: doc.new-extension

Create a file

You can easily create JS files with the file data returned by doc.file().

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });

  const fileData = doc.file();
  const { content, name, type } = fileData;
  let file = {};
  if (typeof File !== 'undefined') {
    file = new File([content], name, { type });
  }
  console.log('------------------------------');
  console.log('[Recipes] Create a file')
  console.log('------------------------------');
  console.log('file: ', file);

  return <div>Check console for logged file</div>;
}

// import Doc from 'unified-doc';
function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  const fileData = doc.file();
  const { content, name, type } = fileData;
  let file = {};
  if (typeof File !== 'undefined') {
    file = new File([content], name, { type });
  }
  console.log('------------------------------');
  console.log('[Recipes] Create a file')
  console.log('------------------------------');
  console.log('file: ', file);
  return <div>Check console for logged file</div>;
}

Preview

Check console for logged file

Export as original/source

Returns the document as-is.

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  return <pre>{JSON.stringify(doc.file(), null, 2)}</pre>;
}

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

Preview

{
  "content": "> **some** markdown content",
  "extension": ".md",
  "name": "doc.md",
  "stem": "doc",
  "type": "text/markdown"
}

Export as `.html`

Returns the document as a valid '.html' file.

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  return <pre>{JSON.stringify(doc.file('.html'), null, 2)}</pre>;
}

// import Doc from 'unified-doc';
function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  return <pre>{JSON.stringify(doc.file('.html'), null, 2)}</pre>;
}

Preview

{
  "content": "<blockquote>\n<p><strong>some</strong> markdown content</p>\n</blockquote>",
  "extension": ".html",
  "name": "doc.html",
  "stem": "doc",
  "type": "text/html"
}

Export as `.txt`

Returns the textContent of a document.

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  return <pre>{JSON.stringify(doc.file('.txt'), null, 2)}</pre>;
}

// import Doc from 'unified-doc';
function() {
  const doc = Doc({
    content: '> **some** markdown content',
    filename: 'doc.md',
  });
  return <pre>{JSON.stringify(doc.file('.txt'), null, 2)}</pre>;
}

Preview

{
  "content": "\nsome markdown content\n",
  "extension": ".txt",
  "name": "doc.txt",
  "stem": "doc",
  "type": "text/plain"
}

Export as `.md`

Returns the document as a valid '.md' file.

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '<blockquote><strong>some</strong> HTML content</blockquote>',
    filename: 'doc.html',
  });
  return <pre>{JSON.stringify(doc.file('.md'), null, 2)}</pre>;
}

// import Doc from 'unified-doc';
function() {
  const doc = Doc({
    content: '<blockquote><strong>some</strong> HTML content</blockquote>',
    filename: 'doc.html',
  });
  return <pre>{JSON.stringify(doc.file('.md'), null, 2)}</pre>;
}

Preview

{
  "content": "> **some** HTML content",
  "extension": ".md",
  "name": "doc.md",
  "stem": "doc",
  "type": "text/markdown"
}

Export as `.xml`

Returns the document as a html-compatible '.xml' file.

Live Code Editor

// import Doc from 'unified-doc';

function() {
  const doc = Doc({
    content: '<blockquote><strong>some</strong> HTML content</blockquote>',
    filename: 'doc.html',
  });
  return <pre>{JSON.stringify(doc.file('.xml'), null, 2)}</pre>;
}

// import Doc from 'unified-doc';
function() {
  const doc = Doc({
    content: '<blockquote><strong>some</strong> HTML content</blockquote>',
    filename: 'doc.html',
  });
  return <pre>{JSON.stringify(doc.file('.xml'), null, 2)}</pre>;
}

Preview

{
  "content": "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head></head><body><blockquote><strong>some</strong> HTML content</blockquote></body></html>",
  "extension": ".xml",
  "name": "doc.xml",
  "stem": "doc",
  "type": "application/xml"
}

Overview

Simple filename operations

Create a file

Export as original/source

Export as .html

Export as .txt

Export as .md

Export as .xml

Export as `.html`

Export as `.txt`

Export as `.md`

Export as `.xml`