Skip to content

FjellOverflow/nordlys

logo

A minimal Astro blog theme

Preview | Features | Installation | Getting started | Documentation | Stack

Features

Nordlys scores 100% on Lighthouse
  • ⚙️ Easily configurable
  • 🔎 Built-in Search
  • 📱 Resonsive & mobile friendly
  • 🧑‍🦯 Accessible
  • 🎨 Built-in & custom color schemes
  • 🌙 Light & Dark mode
  • 🎁 Image zoom, generated Table of Contents, reading time & more ...
  • 👨‍💻 For developers:
    • Best practices
    • Minimal & up-to-date dependencies
    • Strongly typed & linted

Installation

  1. Make sure you have pnpm installed on your system.

    • Clone or fork this repository or
    • Create a new project with pnpm dlx create-astro --template FjellOverflow/nordlys.
  2. Run pnpm install.

  3. Run pnpm dev.

  4. (To install the recommended extensions for VSCode, open the Extensions tab and type @recommended.)

Getting started

The look and feel of the theme are configured in theme.config.ts. Make sure to adjust the title, author, URL, and color scheme to your preferences. Defaults are provided for most settings.

All content is written in Markdown or MDX. Adding new pages, blog posts, or projects is as simple as creating a my-latest-post.md file in the appropriate directory and adjusting the frontmatter. For specific properties that can or need to be set, refer to the provided examples.

Documentation

The theme is self-documenting. Just head over to nordlys.fjelloverflow.dev for examples and tutorials on how to use and customize the theme.

Stack