express-minixed

Minimal and nice-looking directory indexer but now ported to Express Middleware
Original idea was taken from lorenzos@Minixed

What changed?

• Ported to Express Middleware
• EJS template engine
• Auto dark mode (colors inverted)
• Converted PNG icons to SVG

Installation

This is Express Middleware so make sure to install express first
You can install this package through npm

npm install express-minixed

Documentation / Example

Once installed and imported into your code
You must initialize Minixed with your public (static) path

const Minixed = require('express-minixed');
const express = require('express');
const path = require('node:path');

// Getting public path
const publicPath = path.join(__dirname, 'public');

const app = express();

// Setting public path to express
app.use(express.static(publicPath));

// Initialize Minixed
const minixed = new Minixed(publicPath);

Once Minixed has successfully initialized, you can use it.

...

// Actual path should be look like staticPath
// But it can be different

const staticPath = 'public/path';
const actualPath = 'public/path';
app.use(staticPath, minixed.list(actualPath, {
  // minixed options
  fileParse: 'name',
  showDirectories: false,
  showIcons: false
}))

Options

title

Title text of Minixed that can display current path
Warning: If breadcrumbs option set to true title will still have path
Default: Index of {{path}}

subtitle

Subtitle text that can display number of files in directory and its total size
Default: {{files}} object(s) in this directory, {{size}} total

emptySubtitle

Subtitle text when there is no files in directory
Can display files and size like subtitle option
Default: No objects in this directory

ignore

Array of file names to ignore
Sensitive to fileParse option
Default: [] (Empty Array)

fileParse

Displays what the file name will look like
base will display file name and its extension
name will display only file name
For more info see path docs
Default: base
Options: base, name

showParent

Shows parent directory (.. /) if you are in sub directory
Default: true

breadcrumbs

Divides the path in title text into subdirectories that you can navigate through
Default: false

showDirectories

Shows directories in file list
Default: true

showHiddenFiles

Shows hidden files in file list
Default: false

showFooter

Shows credit footer
Don't turn it off if you want to support the project
Default: true

showIcons

Shows icons before the file name
Default: true

sizeDecimals

Displays how many decimals the file size value should show
Default: 2

alignment

How the interface should be aligned
Default: center Options: left, center, right

dateFormat

Format of file date
For more info about format see moment docs
Default: DD/MM/YY HH:mm:ss

robots

HTML meta to disable search robots
Default: noindex, nofollow