notion2eleventy

notion2eleventy is an Eleventy plugin which downloads content from Notion depending on a defined status. It fetches the content via Notions’s API and the the node package @notionhq/client. The content will be converted to md with the help of the lovely node package notion-to-md.

🚀 Features

• Downloads Notion content and assets to your Eleventy project.
• Status driven workflow:
  • It fetches only posts in a specific status you‘ll define.
  • At the end it updates the status.
• The assets will be downloaded to the directory of choice and renamed.
• The notion properties can be setup and added to the Markdown frontmatter (written in camel case).
• Multiple databases can be used and allows to create different post types.
• The cover image in Notion will be copied to the frontmatter by default.

[!IMPORTANT] As from v0.2.0 you need to configure notion2eleventy via the standard eleventy.config.js.

Install the npm package

npm install @stebrech/notion2eleventy

Configure the plugin

Environment variables

Add a .env file to the root folder and add the following variables:

NOTION_KEY=
CHECKSTATUS=
CHECKSTATUS2=
UPDATESTATUS=
NOTION_DB_POSTS=

1. Add your API Key you created on www.notion.so/my-integrations.
2. The name of the status value to take into account. Posts with other status will not be downloaded.
3. Maybe you need another status to check. If not just use the same name as CHECKSTATUS.
4. Which status should the posts get after downloading it.
5. The ID of the Notion database, see Retrieve a database

Configure the plugin in eleventy.config.js

The minimal configuration within the eleventy.config.js (or .eleventy.js) file looks like this:

const notion2eleventy = require("@stebrech/notion2eleventy");

module.exports = function (eleventyConfig) {
  eleventyConfig.addPlugin(notion2eleventy);
};

This will use the default options. The one which need to be overwritten, have to be declared within an object (curly brackets).

Example:

const notion2eleventy = require("@stebrech/notion2eleventy");

module.exports = function (eleventyConfig) {
  eleventyConfig.addPlugin(notion2eleventy, {
    dbId: process.env.NOTION_DB_BLOG,
    postType: "blog",
    requiredMetadata: {
      statusFieldType: "select",
    },
    optionalMetadata: {
      textFields: ["Description"],
      multiSelectFields: ["Tags"],
    },
    permalink: {
      includesYear: true,
      includesMonth: true,
      publishPermalink: true,
    },
    downloadPaths: {
      md: "src/blog/",
      mdAddDatePrefix: false,
    },
    markdownPaths: {
      img: "src/assets/img/",
    },
  });
};

All Config Options

Required Notion metadata (database properties)

// Defaults
requiredMetadata: {
  status: "Status",
  statusFieldType: "status",
  title: "Name",
},

Optional Notion metadata (database properties)

// Defaults
optionalMetadata: {
  layout: "",
  date: "",
  textFields: [],
  multiSelectFields: [],
  selectFields: [],
  dateFields: [],
  checkboxFields: [],
  urlFields: [],
  numberFields: [],
  personFields: [],
  relationFields: [],
  formulaStringFields: [],
  formulaNumberFields: [],
},

Permalink settings

// Defaults
permalink: {
  addPermalink: true,
  includesPostType: true,
  includesYear: false,
  includesMonth: false,
  includesDay: false,
  slug: "",
  publishPermalink: false,
}

Download paths

// Defaults
downloadPaths: {
  md: "src/posts/",
  mdAddDatePrefix: false,
  img: "src/assets/img/",
  imgAddDatePrefix: false,
  movie: "src/assets/movie/",
  movieAddDatePrefix: false,
  pdf: "src/assets/pdf/",
  pdfAddDatePrefix: false,
}

Markdown paths

// Defaults
markdownPaths: {
  img: "/assets/img/",
  movie: "/assets/movie/",
  pdf: "/assets/pdf/",
}

Copy assets to output directory

// Defaults
copyAssetsToOutputFolder: {
  img: true,
  movie: true,
  pdf: true,
}

Use multiple Notion databases

For creating multiple post types in Eleventy, you can create multiple Notion databases. Therefore you’ll call the plugin multiple times in your eleventy.config.js.

Example:

const notion2eleventy = require("@stebrech/notion2eleventy");

module.exports = function (eleventyConfig) {
  // Posts
  eleventyConfig.addPlugin(notion2eleventy, {
    requiredMetadata: {
      title: "Title",
    }
  });

  // Pages
  eleventyConfig.addPlugin(notion2eleventy, {
    dbId: process.env.NOTION_DB_PAGES,
    postType: "pages",
    requiredMetadata: {
      title: "Title",
    },
    optionalMetadata: {
      textFields: ["Description"],
    },
    downloadPaths: {
      md: "src/pages/",
    }
  });
}

Extend scripts

Add the node script in your package.json like:

[!NOTE]
This is no longer necessary as of version v0.2.0

Feedback / Contribution

Please give me feedback dropping me a mail or reach out to me on the Mastodon.

If you find a bug or want to send a feature request please raise an issue on Github. You have a concrete solution – even better. I’m happy to receive your pull request on a separate branch.