README

wordpress-to-docusaurus-plugin

A Docusaurus Plugin which will import Blog content from Wordpress based on a GraphQL query.

Designed to work with Blog posts but could be used as an example for anyone, trying to
create a headless CMS solution.

Configuration

yarn add wordpress-to-docusaurus-plugin

npm install --save wordpress-to-docusaurus-plugin

Add this plugin to the plugins array in docusaurus.config.js.

module.exports = {  
  // ...  Rest of your Docusaurus config
  plugins: [  
    [
        require.resolve('wordpress-to-docusaurus-plugin'),  
        {  
          // URL of the Wordpress GraphQL endpoint   
          url: 'http://my-wordpress-instance/graphql',   
        }  
    ]  
  ]  
}

Extending

createFrontmatter

createFrontmatter: (post: Post) => string

ThecreateFrontmatter option can be configured to create custom Frontmatter.

createPreview

createPreview: (post: Post) => string

ThecreatePreview option can be configured to create a custom preview.

outputPath

outputPath?: string

The outputPath option can be used to define a custom output path (default=blog).

query

query?: string

The query option can be used to define a custom query.

translateContent

translateContent: (content: string, post: Post) => string

The translateContent option can be configured to convert the Wordpress HTML back to markdown, you can extend the default translate function or replace it.

Sample Docusaurus config entry

import { defaultTranslate } from 'wordpress-to-docusaurus-plugin';

const myCreateFrontmatter = (post:Post):string => {
    return ''; // return your frontmatter
}

const myCreatePreview = (post:Post):string => {
    return ''; // return your preview
}

const myTranslateContent = content => {
    return defaultTranslate(content).replace('some html', 'some markdown');
}

const myQuery = ` 
    query { 
        posts { 
            edges { 
                node { 
                  id
                  slug
                  title
                  date
                  excerpt
                  featuredImage {
                    node {
                      sourceUrl
                    }
                  }
                  content
                } 
            } 
        } 
    }
`;

module.exports = {  
  // ...  
  plugins: [  
    [require.resolve('wordpress-to-docusaurus-plugin'),  
        {  
          // Custom Frontmatter creator   
          createFrontmatter: myCreateFrontmatter,
          // Custom Preview creator   
          createPreview: myCreatePreview,
          // Output sub-directory, below site dir (default: 'blog')  
          outputPath: 'my/custom/path', 
          // Custom query   
          query: myQuery,
          // Custom Content translator   
          translateContent: myTranslateContent,
          // URL of the Wordpress GraphQL endpoint   
          url: 'http://my-wordpress-instance/graphql',   
        }  
    ]  
  ]  
}

Usage

When your site is built, the GraphQL endpoint for your configured url will be
used to import posts to the path specified by outputPath.

From your Docusaurus project root directory

yarn start

yarn build

Usage no npm install needed!