Skip to content

ajiangstudy/ajiangstudy.github.io

Repository files navigation

Notion-Hugo

image

Notion-Hugo allows you to use Notion as your CMS and deploy your pages as a static website with Hugo. So you have the full power of Notion for creating new content, with Hugo and its wonderful ecosystem of themes take care of the rest for you.

Get Started

Create a new GitHub repository from this template

Click the green "Use this template" button in the upper-right corner to create your repo from this template. Choose "public" for the repository visibility.

Use this template button

Create a Notion integration

Visit my integrations and login with your Notion account.

Click on "Create new integration" to create a new internal integration.

image

In the capabilities section, select "Read Content" and "Read user information including email address". The "Read Content" permission is necessary for Notion-Hugo to pull your Notion content, and the "Read user information including email address" permission is used to fill front matters with author information. Notion-Hugo does not collect any of your information.

image

Click the submit button to finish creating the Notion integration.

Setup secrets for GitHub Action

Copy the Internal Integration Token.

image

Navigate to the GitHub repo you just created, click on Settings -> Secrets -> Actions.

Click the "New Repository Secret" button on the top right.

image

Add a new secret with name NOTION_TOKEN, paste the copied token into the secret field. Click the green "Add secret" button to save the change.

image

Duplicate the Notion Template

Duplicate this Notion Template into your own workspace.

Share the Notion Page with the integration

Visit the page you just duplicated, click the share button on the top right and share it with the integration you just created.

image

Configure you Hugo site

On the page you just shared with the integration, click on the "share" button again, then click the "copy link" button on the bottom right to copy the link to this page.

image

Now navigate back to your GitHub repository, open the notion-hugo.config.ts file, click to edit the file.

image

Replace the page_url with the link you just copied.

image

Click the commit changes button at the bottom to save the file.

image

Wait a minute or so for your site to be built. You can check the progress under the Actions tab, the CD workflow is building and deploying your site. Then navigate to Settings -> Pages, your Hugo site should now be deployed to the GitHub Pages.

image

There is one final step to make your website work correctly. Copy the url of your new website, then go to file config/_default/config.toml and change the baseURL from https://example.org/ to the url you just copied. Commit the changes and wait for your website to be deployed again.

Now, visit your website again and you will see your content from Notion is rendered into static webpages successfully.

Next Step

Visit the wiki to learn more about how to

  • Pick a different Hugo theme
  • Deploy to other platforms
  • Configure Notion-DoIt

License

This project is open sourced under the GNU GPL license v3, you may use the project under the terms if you are creating an open source project under a license compatible with it.

Consider purchasing a commercial license if your project is not compatible with GPLv3.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published