Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub


A Gatsby theme for publishing knownotes

Setup in your Gatsby project

  1. Install dependency
yarn add gatsby-theme-knownotes
  1. Add these to your gatsby-config.js file:
module.exports = {
  plugins: [
      resolve: `gatsby-theme-knownotes`,
      options: {
        contentPath: path.resolve(__dirname, 'content'),
        rootNote: 'readme',
        wikiLinkLabelTemplate: '[[{{ refWord }}]]',
        getPluginMdx(defaultPluginMdx) {
          return defaultPluginMdx
  1. Add notes to your site by adding md or mdx files in content directory, especially you need a content/readme.md file if you are using above configs.

  2. Start developing your site by running gatsby develop. If you are using above configuration, your start url will be ’http://localhost:8000‘.

© 2023 Gatsby, Inc.