frsthvl/inslide repository overview

⁠Insli.de – Automatic Markdown Presentations

⁠Overview

Insli.de is a simple Nuxt.js application that allows you to automatically create presentations using markdown files instantly. Inspired by Simple Slides⁠, this application supports full Tailwind⁠ CSS, customizable frontmatter, and fetching markdown files from a public URL. No data is stored.

Use it online⁠ (hosted with NuxtHub⁠ on Cloudflare) or install it yourself using this repository.

⁠Features

• Full Tailwind⁠ CSS support
• Automatically create slides from markdown files
• Fetch markdown files from a public URL
• Customizable using frontmatter
• No data stored

⁠Docker Usage

You can use the latest Docker image frsthvl/inslide to deploy your own instance.

⁠Pull the Docker Image

docker pull frsthvl/inslide

⁠Run the Docker Container

By default, the port 3000 is exposed, but you can change it by setting the NUXT_PORT environment variable.

docker run -d -p 3000:3000 \
  -e NUXT_HOST=0.0.0.0 \
  -e NUXT_PORT=3000 \
  -e NODE_ENV=production \
  -e APP_URL=https://YOUR-URL \
  frsthvl/inslide

⁠Docker Compose

You can also use the following docker-compose.yml file:

version: '3.8'
services:
  inslide:
    image: 'frsthvl/inslide'
    ports:
      - '3000:3000'
    environment:
      NUXT_HOST: 0.0.0.0
      NUXT_PORT: 3000
      NODE_ENV: production
      APP_URL: 'https://YOUR-URL'
    restart: always

⁠Development

To develop locally, make sure to create a .env file and set the APP_URL to the URL where the application is hosted.

⁠Install Dependencies

npm install

⁠Start Development Server

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

npm run dev

⁠Build for Production

Build the application for production:

npm run build

⁠Preview Production Build

Locally preview production build:

npm run preview

Check out the Nuxt deployment documentation⁠ for more information.