NotionToHtml

NotionToHtml is a Ruby gem designed to integrate Notion with Ruby applications. It provides a set of tools for rendering Notion pages and blocks, allowing you to maintain a database of pages in Notion while rendering them real time in you application with ease.

Now you can use Notion to publish your pages directly to your Ruby web page with one click.

Table of Contents

• NotionToHtml
• Table of Contents
• About
• Installation
• Dependencies
• Setup
  • Notion Integration
    • Create your integration in Notion
    • Get your API secret
    • Give your integration page permissions
• Configuration
• Usage
  • Rendering
    • Pages
    • Specific Page
    • Customizing styles
    • Overriding default styles
  • Querying
    • Filtering
    • Sorting
• Examples
• Development
• Contributing
• License
• Code of Conduct

About

NotionToHtml allows you to seamlessly integrate Notion pages and blocks into your Ruby application. It provides a set of renderers for various Notion block types, including headings, paragraphs, images, and more. With NotionToHtml, you can easily display and format Notion content in your views.

You just need to create a database in Notion, integrate it and start writing!

Installation

Add the gem to your application's Gemfile:

bundle add notion_to_html

Or install it yourself as:

gem install notion_to_html

Dependencies

NotionToHtml uses tailwindcss classes to define a default styling that mimics Notion's own styling, so make sure to inlcude it in your application. If you wish to use something else you can always override the default styling provided, see Customizing styles for more details.

Setup

This gem is currently very opinionated on how it expects the Notion database to be defined. If you wish to customize this you can override the methods defined in NotionToHtml::Service.

By default the database should have the following structure:

• name, description & slug as Text
• tags as Multi-Select
• public as Checkbox
• published as Date

Once you have the database created you will have to setup a Notion Integration, so the Notion API can communicate with your database. For this you will have to follow the Create Your Integration In Notion tutorial.

If you wish to just quickly set it up, you can follow the relevant steps below, which are taken from that tutorial.

Notion Integration

Create your integration in Notion

The first step to building any integration (internal or public) is to create a new integration in Notion’s integrations dashboard: https://www.notion.com/my-integrations.

1. Click + New Integration.
   
2. Enter the integration name and select the associated workspace for the new integration.
   

Get your API secret

API requests require an API secret to be successfully authenticated.

1. Visit the Configuration tab to get your integration’s API secret (or “Internal Integration Secret”).
   
   Remember to keep your API secret a secret!
   Any value used to authenticate API requests should always be kept secret. Use environment variables and avoid committing sensitive data to your version control history.
   If you do accidentally expose it, remember to “refresh” your secret.

Give your integration page permissions

The database that we’re about to create will be added to a parent Notion page in your workspace. For your integration to interact with the page, it needs explicit permission to read/write to that specific Notion page.

To give the integration permission, you will need to:

1. Go to the page with the database you created above.
2. Click on the ... More menu in the top-right corner of the page.
3. Scroll down to + Add Connections.
4. Search for your integration and select it.
5. Confirm the integration can access the page and all of its child pages.
   
6. You can then limit the integrations permission to just Read Contents:
   

Now you're finally ready to config the gem!

Configuration

To configure NotionToHtml, you need to set up your Notion API token and database ID. If you're using Rails add an initializer file in your Rails application, such as config/initializers/notion_to_html.rb, and include the following configuration block:

NotionToHtml.configure do |config|
  config.notion_api_token = 'NOTION_API_TOKEN'
  config.notion_database_id = 'NOTION_DATABASE_ID'
end

To get these values:

1. The NOTION_API_TOKEN is the same one from the setup.
2. To get the NOTION_DATABASE_ID, locate the 32-character string at the end of the page’s URL.

   https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
                                     |--------- Database ID --------|
   

Remember to keep these values secret!

Now you should be all setup!

Usage

Rendering

Pages

To get and render a preview of the pages of your database:

<% NotionToHtml::Service.get_pages.each do |page| %>
  <%= article.formatted_published_at %>
  <%= article.id %>
  <%= article.formatted_title %>
  <%= article.formatted_description %>
<% end %>

Specific Page

To get and render a specific page:

<% page = NotionToHtml::Service.get_page(page_id) %>
<%= page.formatted_title %>
<%= page.formatted_published_at %>
<% page.formatted_blocks.each do |block| %>
  <%= block %>
<% end %>

Customizing styles

NotionToHtml ships with default css classes for each supported block. You can add your own set of styling on top by specifying the class: option when calling the formatter:

NotionToHtml::Service.get_page(page_id)
  .formatted_title(class: 'text-4xl md:text-5xl font-bold')

You can also specify classes for each type of supported block like this:

NotionToHtml::Service.get_page(page_id).formatted_blocks(
  paragraph: 'text-lg', 
  heading_1: 'text-3xl md:text-4xl font-bold', 
  heading_2: 'text-white', 
  heading_3: 'font-bold', 
  quote: 'italic', 
)

Overriding default styles

If you feel like you want a clean slate regarding styling you can override the provided default styles by setting the override_class option to true:

NotionToHtml::Service.get_page(page_id)
  .formatted_title(class: 'font-bold', override_class: true)

It also works for formatted_blocks:

NotionToHtml::Service.get_page(page_id)
  .formatted_blocks(
    paragraph: { class: 'text-lg', override_class: true }, 
    quote: 'italic' 
)

Querying

By default the NotionToHtml::Service is setup to follow the database structure sepcified above. This way it will only return pages that have been marked as public.

Filtering

You can filter the results by specifying a tag and/or a specific slug:

NotionToHtml::Service.get_pages(tag: 'web', slug: 'test-slug')

Sorting

The default sorting is by the published Date column in the database

Examples

To see how the default renderings of the supported blocks look, go over to the examples.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on Github. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Notion::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.