/Iology.HeadlessUmbraco

Library designed to turn Umbraco into a headless CMS.

Primary LanguageC#MIT LicenseMIT

I-ology HeadlessUmbraco

This is a modified fork of Vertica.Umbraco.Headless.

This is an extension for Umbraco (version 10+) that lets you use your Umbraco content in a headless fashion. It is highly customizable, and you can tweak or replace every aspect of the generated output.

I-ology HeadlessUmbraco is not to be confused with the Umbraco Heartcore, commercial headless SaaS offering from Umbraco. This is purely a rendering framework, designed to replace (or complement) the rendering mechanism within Umbraco.

The framework is build to be:

  • Friendly - plug & play headless CMS capability for Umbraco
  • Flexible - 100% extensible and customizable
  • Open - integrates seamlessly with the Umbraco ecosystem, thus imposing no limitations towards other Umbraco packages and add-ons

Getting Started

This package is not available on NuGet.

To use this package, you must do the follow

  • Install package as a Git submodule
  • Add reference to package within your C# project
git submodule init
git module add git@github.com:Iologyinc/Iology.HeadlessUmbraco.git

Now open the Startup class of your Umbraco project and include the core extensions by adding:

using Iology.HeadlessUmbraco.Core.Extensions;

Lastly add AddHeadless() to the IUmbracoBuilder setup in the ConfigureServices(...) method of the same class:

public void ConfigureServices(IServiceCollection services)
{
  services.AddUmbraco(_env, _config)
    .AddBackOffice()
    .AddWebsite()
    .AddComposers()
    .AddHeadless() // Adds I-ology HeadlessUmbraco to Umbraco
    .Build();
}

Provided your site has any published content, it will now be returned as JSON when requested.

By default, I-ology HeadlessUmbraco takes over the entire output rendering, meaning any existing Umbraco templates will no longer be invoked. However, this (and much more) can be changed and tailored to your specific needs. Have a read through the documentation below.

Documentation - table of contents