npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wordpress-to-docusaurus-plugin

v1.0.0

Published

Docusaurus plugin for importing Wordpress posts

Downloads

13

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

or

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

or

yarn build