https://github.com/fjelloverflow/nordlys

A minimal Astro blog theme
https://github.com/fjelloverflow/nordlys

astro astro-template astro-theme ssg tailwindcss template

Last synced: 3 months ago
JSON representation

A minimal Astro blog theme

• Host: GitHub
• URL: https://github.com/fjelloverflow/nordlys
• Owner: FjellOverflow
• License: gpl-3.0
• Created: 2024-09-25T13:16:26.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T19:02:20.000Z (3 months ago)
• Last Synced: 2024-10-25T14:53:53.177Z (3 months ago)
• Topics: astro, astro-template, astro-theme, ssg, tailwindcss, template
• Language: Astro
• Homepage: https://nordlys.fjelloverflow.dev/
• Size: 1.51 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


  

    

  





  Nordlys





  A minimal Astro blog theme



![Preview](./public/preview.png)



  

   

  

   

  





  Preview |

  Installation |

  Getting started |

  Documentation |

  Stack



> [!IMPORTANT]  

> This theme is in early development. If you come across bugs, mistakes or have suggestions on the direction of the project, feel free to [open an issue](https://github.com/FjellOverflow/nordlys/issues/new/choose)!

## 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/)

- **Styling**: [TailwindCSS](https://tailwindcss.com/)

- **Font**: [IBM Plex Sans](https://fonts.google.com/specimen/IBM+Plex+Sans)

- **Icons**: [Tabler Icons](https://tabler.io/icons)