{"id":13658831,"url":"https://github.com/victornpb/notion-jam","last_synced_at":"2025-07-11T13:34:45.232Z","repository":{"id":41092162,"uuid":"492343865","full_name":"victornpb/notion-jam","owner":"victornpb","description":"Sync pages from Notion to GitHub to be used as a static website (JAM)","archived":false,"fork":false,"pushed_at":"2023-06-07T15:04:29.000Z","size":24946,"stargazers_count":62,"open_issues_count":8,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T01:14:03.822Z","etag":null,"topics":["cli","github-actions","github-pages","jamstack","markdown","notion","notion-integrations"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/notion-jam","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victornpb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://www.buymeacoffee.com/vitim"],"github":null,"patreon":null,"open_collective":null,"ko_fi":"victornpb","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null}},"created_at":"2022-05-14T23:13:40.000Z","updated_at":"2025-03-28T21:50:59.000Z","dependencies_parsed_at":"2024-08-02T05:18:01.313Z","dependency_job_id":null,"html_url":"https://github.com/victornpb/notion-jam","commit_stats":{"total_commits":77,"total_committers":1,"mean_commits":77.0,"dds":0.0,"last_synced_commit":"9669a16f172e2ef5982fcf8fbe527742a88a3060"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victornpb%2Fnotion-jam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victornpb%2Fnotion-jam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victornpb%2Fnotion-jam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victornpb%2Fnotion-jam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victornpb","download_url":"https://codeload.github.com/victornpb/notion-jam/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137891,"owners_count":21053775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","github-actions","github-pages","jamstack","markdown","notion","notion-integrations"],"created_at":"2024-08-02T05:01:02.970Z","updated_at":"2025-04-10T01:14:19.154Z","avatar_url":"https://github.com/victornpb.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/vitim","https://ko-fi.com/victornpb"],"categories":["JavaScript","HarmonyOS"],"sub_categories":["Windows Manager"],"readme":"\n![](./banner.fw.png)\n\n# notion-jam\n\u003c!-- badge --\u003e\n[![GitHub Action: View on Marketplace](https://img.shields.io/badge/GitHub%20Action-View_on_Marketplace-blue?style=flat-square\u0026logo=github)](https://github.com/marketplace/actions/notion-jam)\n[![Version](https://img.shields.io/npm/v/notion-jam.svg?style=flat-square)](https://www.npmjs.com/package/notion-jam)\n[![Downloads](https://img.shields.io/npm/dt/notion-jam.svg?style=flat-square)](https://www.npmjs.com/package/notion-jam)\n[![CodeFactor](https://www.codefactor.io/repository/github/victornpb/notion-jam/badge?style=flat-square)](https://www.codefactor.io/repository/github/victornpb/notion-jam)\n[![Node](https://img.shields.io/node/v/notion-jam.svg?style=flat-square)](package.json)\n[![LICENSE](https://img.shields.io/github/license/victornpb/notion-jam?style=flat-square)](LICENSE)\n\u003c!-- endbadge --\u003e\n\n\n**Sync pages from Notion to GitHub to be used as a static website ([JAM][jamstack])**\n\n- Notion pages are converted to markdown files.\n- Database properties are automatically added as yaml frontmatter\n- All images are downloaded locally and path rewritten to relative paths\n- Page cover is downloaded\n- Thumbnail property is added automatically to the frontmatter using page cover, first image, icon, or image number (configured by post)\n---\n\n## Usage\n\n### Quick Start\n\n1. Create a new Notion Integration\n    \n    ![notion secret](https://user-images.githubusercontent.com/3372598/168543273-8b592c0d-8459-4669-a608-4473edcd4a40.gif)\n\n    \n2. Add Notion secret to GitHub repository\n    1. Go to `github.com/{user}/{repo}/settings/secrets/actions`\n    2. Set `NOTION_SECRET` of Notion to your repository secret.\n        \n        ![add notion secret to github](https://user-images.githubusercontent.com/3372598/168543331-efb3a64a-d126-477d-84db-d05b22131ce4.gif)\n    \n3. Share the Database with the integration\n    \n    ![add perm](https://user-images.githubusercontent.com/3372598/168543407-b8d7373a-c6ea-4e2a-9eef-2a29f6a557bb.gif)\n    \n4. Create a workflow in `.github/workflows/**.yml` of your repository\n    \n    ### Example Workflow\n    \n    ```yaml\n    # This is a basic workflow to help you get started with Actions\n    \n    name: NotionJAM\n    \n    # Controls when the workflow will run\n    on:\n      schedule:\n        - cron: \"0 21 * * *\" # daily\n      push:\n        branches: [master, main]\n    \n      # Allows you to run this workflow manually from the Actions tab\n      workflow_dispatch:\n    \n    # A workflow run is made up of one or more jobs that can run sequentially or in parallel\n    jobs:\n      # This workflow contains a single job called \"build\"\n      build:\n        # The type of runner that the job will run on\n        runs-on: ubuntu-latest\n    \n        # Steps represent a sequence of tasks that will be executed as part of the job\n        steps:\n          # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it\n          - uses: actions/checkout@v3\n    \n          - name: notion-jam\n            uses: victornpb/notion-jam@v0.0.10\n            with:\n              NOTION_SECRET: ${{ secrets.NOTION_SECRET }}\n              NOTION_DATABASE: https://www.notion.so/9e34cee9f5bd4c4aaf0d2eaf73ead47b\n              FILTER_PROP: Status\n              FILTER_VALUES: Published\n              CONVERT_PROP_CASE: snake\n              ARTICLE_PATH: content/posts/{title}/README.md\n              ASSETS_PATH: ./\n              PARALLEL_PAGES: 25\n              PARALLEL_DOWNLOADS_PER_PAGE: 3\n              DOWNLOAD_IMAGE_TIMEOUT: 30\n              SKIP_DOWNLOADED_IMAGES: true\n              DOWNLOAD_FRONTMATTER_IMAGES: true\n          \n          - name: Save changes\n            uses: stefanzweifel/git-auto-commit-action@v4\n            with:\n              commit_message: Commit changes\n    ```\n    \n\n## Configuration\n\n### Parameters\n\n| Name | Description | Required | Default |\n| --- | --- | --- | --- |\n| NOTION_SECRET | Notion API Token secret | ✅ |  |\n| NOTION_DATABASE | Notion Database URL or ID (example: https://notion.so/00112233445566778899aabbccddeeff) | ✅ |  |\n| FILTER_PROP | Property on the database used to query pages |  | Status |\n| FILTER_VALUES | Return pages with the FILTER_PROP is equal this list of values |  | Ready,Published |\n| CONVERT_PROP_CASE | Convert the database property names before adding to the frontmatter (camel,pascal,kebab,snake,none) |  | snake |\n| ARTICLE_PATH | Path template to where to save markdown files |  | posts/{title}/README.md |\n| ASSETS_PATH | Path to save images, if started with . will be relative to ARTICLE_PATH, otherwise absolute |  | ./ |\n| PARALLEL_PAGES | Fetch this amount of pages in parallel |  | 25 |\n| PARALLEL_DOWNLOADS_PER_PAGE | Number of images to download in parallel for each page |  | 3 |\n| DOWNLOAD_IMAGE_TIMEOUT | Timeout in seconds for each image download |  | 30 |\n| SKIP_DOWNLOADED_IMAGES | Skip downloading images if they already exist in the path |  | true |\n| DOWNLOAD_FRONTMATTER_IMAGES | Downloads image urls in the frontmatter |  | true |\n\n\n  [jamstack]: https://jamstack.org/what-is-jamstack/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictornpb%2Fnotion-jam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictornpb%2Fnotion-jam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictornpb%2Fnotion-jam/lists"}