⚠️ Deprecation Notice

This repository has been archived and is no longer maintained.

Kontent 💖 Statiq - Lumen Starter

Lumen is a minimal, lightweight, and mobile-first starter for creating blogs using Statiq and Kontent by Kentico.

Features

• Content from Kontent headless CMS.
• Kontent Web Spotlight
• Beautiful typography inspired by matejlatin/Gutenberg.
• Mobile-First approach in development.
• Stylesheet built using SASS and BEM-Style naming.
• Syntax highlighting in code blocks.
• Archive organized by tags and categories.
• Automatic Sitemap generation.
• Open Graph & Twitter Cards support
• RSS/Atom support out of the box
• Google Tag Manager support
• Automatic Dark Mode

Getting Started

Requirements

• .NET 5.0

Clone the codebase

1. Click the "Use this template" button to create your own repository from this template.

Running locally

• dotnet run -- preview
  • You can also emulate running the project in a virtual directory by appending --virtual-dir statiq-starter-kontent-lumen. See all preview options.
• Go to http://localhost:5080/

🎊🎉 You are now ready to explore the code base!

By default, the content is loaded from a shared Kontent project. If you want to use your own clone of the project so that you can customize it and experiment with Kontent, continue to the next section.

Create a content source

1. Go to app.kontent.ai and create an empty project

2. Go to the "Project Settings", select API keys and copy the following keys for further reference

   • Project ID
   • Management API key

3. Use the Kontent Backup Manager and import data to the newly created project from content.zip file via command line:

    npm i -g @kentico/[email protected]
   
    kbm --action=restore --projectId=<Project ID> --apiKey=<Management API key> --zipFilename=content

   Go to your Kontent project and publish all the imported items.

4. Map the codebase to the data source

   • adjust the DeliveryOptions:ProjectId key in appSettings.json

🚀 You are now ready to use the site with your own Kontent project as data source!

Production deployment

Netlify

This template contains default configuration for deployment to Netlify. Just click the button below and deploy in seconds!

GitHub pages

• Enable GitHub actions in your repo
• Copy the .github/workflows/dotnet-core.yml to your project
• Go to the repository secrets and set:
  • LinkRoot to the relative path of your project (e.g. /statiq-starter-kontent-lumen) - this is to ensure that all links work properly when deployed to a subfolder
  • Host to the domain of your project (e.g. domain.tld) - this is to ensure that absolute links are generated where required

Configuring features

Google Tag Manager

-> just add "TagManagerId": "GTM-XXXXXXX" to appsettings.json

Web Spotlight

• Add Web Spotlight to your current plan
• Set up preview URLs
• Start editing!

Original work

This template is licensed under the MIT license and the credits for the original work on the template go to Alexander Shelepenok.