Welcome to the notion-cms-tools wiki! (Alpha version, not recommended to use)
What is notion-cms tools?
It's a simple javascript library that allows you to create headless cms for your website very fast. It is recommended to use in projects that require SSG or SSR usage. You can also extend capabilities of tools pack with additional modules (in work).
For now you can use additional image processors that process your images from notion page and serve them from CDN.
How to install?
npm i @macpaw/notion-cms-tools@latest
and you are good to go
Main functions
- Convenient Notion API Parsing
- Utils
Before using
You should add these environment variables firstly.
NOTION_SECRET # your notion access token
DATABASE_ID # db id you want to access
Example
###Code
import { getPages } from '../index.js';
import { parsePages } from '../parser/index.js';
import { getLoader } from '../image-loader/aws/index.js';
function getFilter() {
return {
property: 'Status',
select: {
equals: 'Published',
},
};
}
async function test() {
const data = await getPages(getFilter()); // loads db props data with filter
console.log('Data is loaded');
const parsedData = await parsePages(
// parsing page props
data,
{
properties: [
// validation params
'Title',
'Date',
'Topics',
'Where',
'Cost',
'Head Image',
'Applying link',
'Status',
'Colored Background',
'Grey Background',
'Pink Background',
],
},
{ imageLoader: await getLoader() } // loader setting (image/aws s3)
);
return parsedData;
}
console.log(await test());
Output
Data is loaded
Size 73795d065fa338d1be7e1602a9508ad20f1183c12e0c36e8f0e6f2bd4fbb64e2:
original 152059
webp 51849
Size dcd203a6338cbfdb39829bc30204059c242ad5063af1cf84ed724ba00541126a:
original 389440
webp 210071
Validated!
[
{
id: '2f7ce682-a656-4836-96f1-646dc8930b76',
properties: {
coloredBackground: [Object],
headImage: [Object],
topics: [Object],
cost: [Object],
pinkBackground: [Object],
status: [Object],
greyBackground: [Object],
applyingLink: [Object],
where: [Object],
date: [Object],
title: [Object]
}
},
...
{
id: '487fdfc2-ae4a-457f-a421-486c3611c91b',
properties: {
coloredBackground: [Object],
headImage: [Object],
topics: [Object],
cost: [Object],
pinkBackground: [Object],
status: [Object],
greyBackground: [Object],
applyingLink: [Object],
where: [Object],
date: [Object],
title: [Object]
}
}
]
Library Release Process
Our library release process is designed to ensure quality, consistency, and proper versioning. The process is broken down into multiple stages to ensure every change is tracked, reviewed, and integrated appropriately. We use changesets for version and release management.
1. Adding Changes
Whenever you introduce a new change, run the command:
You have to do this at least once per branch with some changes.
npm run changes:add
- The CLI will prompt you with questions regarding your changes. You'll need to specify the nature and level of the changes (options: patch, minor, major).
- After completing the CLI prompts, commit the changes with a commit message similar to
chore: update changesets
.
2. Releasing and Publishing
Steps to make a release:
- To initiate a release, create a pull request from `master`` to release with the title Release.
- Ensure all CI checks pass successfully.
- Once CI checks are green and you have at least one approval, merge the pull request.
- Post-merge, the release GitHub Actions will trigger and create an "update versions" pull request to the
release
branch. - Wait for the CI to turn green on the "update versions" pull request.
- Once CI is green, merge the "update versions" pull request.
- After this merge, the actions will trigger again. This time, they'll generate a new tag, create a new release, and publish packages to both GitHub and npm registries.
3. Post-Release Activities
After a successful release, ensure you create a backmerge pull request from release to master
. This ensures that the master
branch stays up-to-date with the latest versions and changes.