An open API service indexing awesome lists of open source software.

https://github.com/semanticdata/site


https://github.com/semanticdata/site

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          



logo


Nordlys


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

0. Make sure you have [pnpm](https://pnpm.io/installation) installed on your system.

1. - Clone or [fork](https://github.com/new?template_name=nordlys&template_owner=FjellOverflow) 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](https://nordlys.fjelloverflow.dev/posts/) for examples and tutorials on how to use and customize the theme.

## Stack

- **Language**: TypeScript
- **Framework**: [Astro](https://astro.build/)
- **Search**: [Pagefind](https://pagefind.app/)
- **Styling**: [TailwindCSS](https://tailwindcss.com/)
- **Font**: [IBM Plex Sans](https://fonts.google.com/specimen/IBM+Plex+Sans)
- **Icons**: [Tabler Icons](https://tabler.io/icons)