Changelog

 

Stay up-to-date with updates and improvements to HelpKit


🚀 FEATURE

June 13, 2022

👨‍👩‍👧‍👧 Introducing multi user support

We are excited to announce that HelpKit now supports teams. Invite new members to your knowledge base or manage existing ones via the new Manage members tab in your project settings.

 
Notion image
 

How does it work?

  1. Navigate to Manage members tab in your project settings
  1. Invite a new member by email and give him/her a role
  1. The member will receive an email with a button that allows to join the project
 

Currently there are two roles you can assign your members:

 
  • Viewer: Can view knowledge base insights and sync articles
  • Editor: Can change non-critical knowledge base settings (all setting tabs except General, Manage Members and Project Billing), view insights and sync articles
 

The user who has created to project gets assigned an unique Admin role that allows to invite members, change their roles and revoke access.

 

🛠️ IMPROVEMENT

June 10, 2022

🔒 Password access page custom javascript support and better error page

You can now use our custom javascript feature on the /access page when protecting your knowledge base. With custom javascript you can implement your own programmatic logic to automatically login your users. We suggest you to do a path check to prevent infinite loops.

Notion image
 

Moreover, we have spent some time designing the default server error page:

Notion image
 

🚀 FEATURE

May 15, 2022

🔢 Multiple knowledge bases per account

We are excited to annouce that you can finally manage multiple knowledge base sites under one account. This drastically improves the user experience for customers with the need for more than one site as they don’t need to sign up with a new email anymore and pay seperately. Additionally we have added a new billing section in your account settings where you can manage and upgrade your subscription plans.

 

With this new feature we are also introducing special agency deals for customers with the need for more than three knowledge bases. Reach out and ask for more details.

Notion image
 

🛠️ IMPROVEMENT

May 15, 2022

🔢 Speedy initial page load and Table of Contents for Help Layout

We have noticed that due to the increasing growth of HelpKit some sites were loading slower than expected on the first page load. We hear you! For this reason we have improved our caching layer to make it as fast as possible ⚡ We hope you are as excited as we are 😉

 

Additionally we have ported over the table of contents section from our beloved doc layout to the help center layout as well. Whenever you create a header in Notion with the ## ### #### tags HelpKit will create a table of content section with onclick smooth scroll to the article’s position. The TOC for the help center layout is disabled by default. You can easily toggle it one by navigating to Settings/Look & Data and scroll down until you see the toggle.

Notion image
 

🚀 FEATURE

May 15, 2022

📌 Auto suggest articles and pretty print

From now on, as soon as your customer starts typing in the contact form we will automatically suggest relevant help articles from your knowledge base helping you to reduce support tickets.

Notion image
 

Furthermore, we have added a 🖨️ Print button to your articles so that customers can print out articles or save them as an PDF. It was quite a hassle to make sure the print outcome looks decent 😬 We definitely learned a lot about CSS and JS queries related to media print.

 
💳
Please note that these two features are part of the Professional Plan
 

🚀 FEATURE

April 18, 2022

👨‍💻 Code Highlight and Sync Block support

Notion’s code block is a great addition for your technical documentation. We want to make your readers’ experience as smooth as possible and thus, we enhanced the coding block with a beautiful header that can display your file name and also has a copy and paste clipboard button. To enable it, all you need to do is add a caption to the coding block in Notion.

Notion image
 

Moreover, we have implemented full sync block support. Sync blocks are a great way in Notion to reuse the same blocks from one article in other articles. Sync blocks automatically update all associated children blocks making it easy to not repeat yourself unnecessarily.

Notion image
 

🚀 FEATURE

March 21, 2022

💬️ Improve your articles with textual feedback

HelpKit allows your customers to react on your articles and provide feedback. Once dissatisfied, it is crucial for you to understand why users didn't like an article or why they haven't found it helpful. Our new textual feedback feature will open up a modal whenever your users react on your articles prompting them to provide more textual feedback.

 

They can also optionally leave their email address so you can get back to them with further questions. All comments are easily findable in the HelpKit dashboard and we are working on ways to surface them even better in the future.

 

🛠️ IMPROVEMENT

March 21, 2022

🔢 Support for 1-level category subcollections

We hear you! 😊 Some of you want to server their main category as a single subcollection. We now support 1-level hierarchies for your Notion article tables.

Notion image
 

How does it work?

Excellent question. It’s super simple. In order to achieve a one-level hierachy all you have to do is leave the title of your Notion subcollection “Untitled” (please note that the font color should be gray) or give it the name: “no_sub_collection_name”. This way HelpKit nows that you plan to only show one subcollection for your category and will adjust the design accordingly.

Notion image
 

🛠️ IMPROVEMENT

March 20, 2022

Widget opens up much faster, contact button for documentation layout and minor bug fixes

We are happy to announce that our help widget now opens articles in-context almost instantly 🔥 This will give your customers a much better reading experience. In addition, we also have added contact button support for the documentation layout + widget. We also improved the navigation within the documentation layout widget.

 

🐛 Additional fixes:

  • Fixed password protected site freeze bug: Sites would freeze after ~15min of stale non-usage
  • Added localization for "Table of Context" text
  • no_sub_collection_name does not show up in the search bar anymore
 

🛠️ IMPROVEMENT

February 17, 2022

⚡Introducing: HelpKit Cache – Articles loading up to 10x faster

Señoras y señores, we are excited to announce our new caching system that allows us to serve your help articles much faster than in the past. Up to 10x faster 💨 We heard your concerns about some help articles taking a bit longer than anticipated when being fetched from Notion. For this reason we have decided to completely revise our caching system so that your customers can get help even quicker.

 
Notion image
 

How does the new sync work?

In order for the new cache system to work, we have made some minor changes to how syncing works. You can read it in detail here: https://support.helpkit.so/getting-started/syncing-your-knowledge-base

 

TLDR; When clicking the 🔁 Snyc now button, HelpKit will:

  1. First try to fetch your knowledge base structure and check if all Notion fields are reachable.
  1. If successful, HelpKit will go ahead and start syncing your articles.

HelpKit will then estimate the sync duration for you and display a progress bar. While syncing your articles are still reachable by your customers. Syncing continues in the background even when closing the browser window, so you don’t have to worry.

 

How long does it take to sync?

When syncing your knowledge base from Notion to HelpKit you now have two options:

  1. Sync the entire knowledge base with 🔁 Snyc now : Depending on the amount of articles in your knowledge base a full sync can take between 30 seconds and 3 mintues.
  1. Sync an indiviual article with 🔁 Resync : Syncing a single article is very fast and should not take longer than a couple of seconds. We recommend doing an individual article sync whenever you are updating an article and want to get the update quickly published.
 

That’s it! 🥳 As always, if you have any questions or feedback; we would love to hear from you 🙋‍♂️

 

 

🚀 FEATURE

February 16, 2022

🔗 Create Alias Redirect Links

HelpKit’s new article redirect feature allows you to create alias links for your help articles. This allows you to enter an alternative path that redirects to your target article. Besides being helpful for sending shorter/concise links it can also help migrating from another knowledge base service while keeping the same custom domain.

 
Notion image
 

Learn more about how to create alias links here: https://support.helpkit.so/customization/customizing-and-redirecting-article-urls (😎 ...shortened by the alias feature)

 

🛠️ IMPROVEMENT

February 16, 2022

🔍 New search bar for finding help articles in the admin dashboard

The title says it all. We have added a new searchbar to the admin dashboard so that you can easily find and edit all your articles. The search is almost instant, so rumor has it that you will find your articles faster than Usain Bolt 🏃‍♂️💨 

 
Notion image
 

🛠️ IMPROVEMENT

February 16, 2022

Portrait images, new custom CSS classes, documentation layout improvements and more...

Hey folks! We have added a bunch of new improvements to HelpKit. There are quite a few so we prepared some neat bulletpoints for you:

 
  • Portrait images: As of now HelpKit displays images with a full width of 100%. While this workes perfectly for horizontal images, it can scale up vertical images a bit too tall. We have now added an algorithm that recogonizes veritcal/horizontal images and sizes them accordingly.
💡
Please note: We are still experimenting with this feature. If you encounter any issues or have feedback, please reach out!
  • Copying the article link now uses the custom domain’s link instead of default HelpKit link
  • Article links now are all lower case - no worries your links all still work even if they contain capital letters. The change just affects the overall link aestehtics as links generally do not have capital letters in them
  • Code block now supports more programming languages for color highlights
  • Documentation layout: Suggested articles now are also supported on the
  • Documentation layout: Sidebar now expands and contracts based on current collection and article
  • Documentation layout: Sidebar now shows a beautiful scroll bar when the view height gets smaller
    •  
Notion image
 

 

🚀 FEATURE

January 8, 2022

🧮 New Notion Block: Simple Tables are now supported

 

It happened! Notion finally introduced the simple table block type. This was a widely requested and long anticipated feature from the Notion community. The pain was so real that we even decided to build a free tool that would allow you to create simple tables. We got creative and found a workaround for generating tables with Notion’s math formula block. It ranked #5 Product of the Day on Product Hunt and over 10.000 users could finally generate useful tables for their Notion pages. A couple of weeks ago Notion introduced their own native solution and so it made perfect sense to implement it into HelpKit as well. The simple table block is great for structured data. Some of our customers use it do display their API endpoints and it looks fantastic!

 
Notion image
 

 

🚀 FEATURE

January 5, 2022

🎨 Endless possibilities with the new Custom CSS feature

While HelpKit’s editor provides a lot of possibilities to customize your knowledge base, we know that sometimes you have the need to dive deeper. The new custom CSS feature allows you to technically target every single element in your knowledge base site. Go wild! 👩‍🎨

 

We are currently working on adding custom classes that you can target easier. Please reach out if you are missing something.

Notion image
 

 

🛠️ IMPROVEMENT

January 3, 2022

Widget API: Programmatically show contact form

This new update allows you to easily show the contact form your users. Something went wrong in your app? Want to prompt your users for certain feedback after they have performed an action? Simply call Helpkit.show('popover', 'contact') in your javascript code.

 

🧑‍🎓 Learn how to use the Widget API here

 
Notion image
 

 

🛠️ IMPROVEMENT

December 8, 2021

Image view mode, Intercom integration & performance improvements

First of all, we want to thank all customers for the amazing and helpful feedback. We have just shipped two improvements and one new integration provider.

 

From now on users will be able to view your pictures in a full-screen viewing mode when clicked. Using Intercom as your live chat provider? You can now easily integrate your Intercom widget with your HelpKit help center and widget. Last but not least, we worked hard to improve the syncing speed and also prepared our servers better for future growth 💪

 
Notion image
 

 

🚀 FEATURE

November 25, 2021

🌟 Custom JavaScript

Our custom JavaScript feature allows you to embed custom JS code to your HelpKit site. Need to implement your own code or a service we don't provide out of the box yet? Then this is what you are looking for ✨

 

All you have to do is:

  1. Go to Settings/Integrations and scroll down to the Custom JavaScript section
  1. Enter your custom JS code
  1. Hit save
Notion image
⚠️
IMPORTANT: Please make sure that you wrap your custom js code within a <script></script> tag. You can add multiple script tags below each other if necessary. Please only embed code from providers that you trust.
 

 

🛠️ IMPROVEMENT

November 10, 2021

⏯️ Custom Link for Contact Us Button

HelpKit allows you to connect a wide range of contact providers to the Contact Us button. If you want you can also set a custom link for the Contact Us button. This is especially helpful if you want to provide help via WhatsApp, Telegram or a simple mailto email link.

 

Want people to contact you via WhatsApp? Want people to join your Telegram group or DAO discord chat? HelpKit got you covered.

Notion image
 

 

🚀 FEATURE

October 18, 2021

💬 Introducing: Contact Providers

Contact providers are a feature of HelpKit that help your customers contact you. In a perfect world your knowledge base articles should solve all your customers questions. However, we all know that we unfortunately don't live in a perfect world and if customers need to contact you, they should have a great experience doing so.

 

HelpKit currently supports the following three contact integrations:

 
 

You can setup your Contact integration via Settings/Contact Integration. Choose your preferred provider, enter the required information such as an Website Widget ID and click save.

Notion image
 

 

🛠️ IMPROVEMENT

October 18, 2021

New Widget Code

We massively improved the widget code. From now on you don't need a config object anymore. All you need is one line of code. All your dashboard changes are automatically applied to your widget. No need to replace the code.

Notion image

Before:

<script>
        var HelpkitConfig = {
            id: "try",
            button: {
                display: true,
                position: "bottom_right",
                backgroundColor: "rgba(59, 35, 76, 1)",
                icon: 'questionMark'
            },
            contact: {
                provider: 'crisp',
                appId: '2342343'
            }
        }
</script> 
<script type="text/javascript" src="https://www.helpkit.so/widget/script.js" async></script>

After:

<script id="helpkit-widget" data-project-id="debug" type="text/javascript" src="https://www.helpkit.so/widget/script.js" async></script>
 

 
 

🚀 FEATURE

October 18, 2021

📝 Introducing: Documentation Layout

Documentation is an essential component of any software product. It explains what the software does, how it works, how it integrates with other tools, and provides a look behind the scenes.

 

With the addition of the new documentation layout you can now change the style of your knowledge base site between a Help Center and Documentation look.

 

The new documentation layout has all sub collections pinned to a convenient left sidebar and also displays a table of content for each individual article. At HelpKit we care a lot about details, so we made the table of content sections reactive based on your users reading progress.

 

HelpKit's mission is to make a user-friendly, easy and productive product for companies to create, edit and share knowledge and we hope that the new doc layout will make it even better.

Notion image
Notion image

🚀 FEATURE

October 18, 2021

📧 Interactive contact form

Until today, HelpKit's Contact Us button was simply a mailto link pointing to your support email address. We decided to improve this crucial process and craft a fully interactive contact form that your users can fill out and send to you. After a user has submitted the contact form, HelpKit will send you a dedicated notification email with the user's message. You can then simply reply to the email so that the user will get an answer.

 

While this is not a full fledged out ticketing system yet, it tremendously improves the user experience and we are constantly learning from your feedback to make it better.

 
Notion image
 

🛠️ IMPROVEMENT

October 17, 2021

🎛️ Smooth widget animations and article expansion

HelpKit's widget has now a beautiful opening and closing animation which makes it feel much smoother. Additionally, we decided to automatically increase the width of your widget whenever an article is opened. This will enhance your customers' reading experience a lot.

 
Notion image
 

🛠️ IMPROVEMENT

October 16, 2021

💬 Choose your widget icon

From now on you can choose between a speech bubble and question mark widget icon and even hide the text so that only a circle shows up. Moreover, the help bubble now switches from a help bubble to a close icon when opened.

Notion image
 

🚀 FEATURE

October 14, 2021

📊 Analytics support

We have added third-party analytics support so that you can track your page views and see which articles are viewed the most. Currently we support Google Analytics and Plausible – a privacy friendly alternative. If your favorite analytics tool is missing just reach out and tell us which one you would like to see being added.

Notion image
Notion image