Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.16 KB

README.md

File metadata and controls

78 lines (53 loc) · 2.16 KB
Raw

Logspot

Logspot is a lightweight, free and open source template for your changelog made with Vue, Nuxt and Tailwindcss.

image

How it works?

  1. Each .md file in /content/posts/ counts as one changelog post, logspot uses the nuxt content module

Features

  1. Markdown support
  2. Icons support using Iconify
  3. Code syntax highlighting using Shiki.js
  4. Frontmatter - dates, author supported
  5. Vue components inside markdown using Nuxt contents MDC format - More on this here
  6. Icons support - :icon{name="ph:user-circle-duotone"} will show a user icon - find more icons at https://icones.js.org
  7. Alert component with icon, title and description.

Format

::alert
---
icon: fluent:error-circle-24-regular
title: This is alert with default variant colors.
description: This will pick up colors from your primary color set in the tailwind config file. You can use this to show some kind of message to your users.
---
::

This above content will render a alert component, something like this Screenshot2023-01-30 at 01 17 36@2x 8. Widget page, Logspot also has a page specifically meant for widgets, here's an example

logspot.mp4

Setup Locally

Make sure to install the dependencies:

# yarn
yarn install

# npm
npm install

# pnpm
pnpm install --shamefully-hoist

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Checkout the deployment documentation for more information.