npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

menimal

v0.1.1

Published

Generate a static html-only website from markdown and css

Downloads

12

Readme

Menimal is a minimal static site generator.

Focus on content: just write markdown files, css styles, and everything else is generated for you

Menimal folder structure

Menimal is minimal by design:

  • No javascript (no package.json)
  • No HTML templates
  • No mdx
  • No SEO or metadata

Getting started

Menimal is a single npx script that you can run from everywhere without installing any package.

👉 Make sure you have NodeJs installed on your machine

You just need to run a single command:

npx menimal

This will generate a build folder containing your static website.

Deploy

Hosting platforms allow to define a build command and an output folder:

  • Build command: npx menimal
  • Output folder: build

Deploy config

Menimal build folder

That's all. You can deploy Menimal everywhere 🤝


Folder structure

Menimal requires a precise folder structure:

  • pages: contains markdown files (.md)
  • static: contains static files (robots.txt, fonts, favicon.ico)
  • config.json: contains site configuration (minimal)
  • style.css: contains styles (single css file)

See complete and working example inside example folder

pages

Every markdown file will correspond to an .html page in the website.

The name of the file .md is used to generate both the name of the HTML file and the title of the page:

  • HTML file: same as .md with all lowercase characters
  • Title: same as .md with - replaced by spaces

For example, This-is-the-Title-of-the-article.md will generate:

  • HTML: this-is-the-title-of-the-article.html
  • Title: This is the Title of the article

static

All the files inside static will be copied in the final build.

Here you can add images, fonts, robots.txt, favicon.ico, sitemap.xml, or anything really 💁🏼‍♂️

config.json

For now config requires a single field: the name of the website displayed in <header>:

{
  "name": "Sandro Maglione"
}

style.css

All the styles are defined in a single css file.

You can view the generated HTML structure of each file inside templates

This file will be minified and imported in every generated page.

Roadmap

  • Preload fonts in HTML
<link rel="preload" href="font.woff2" as="font" crossorigin type="font/woff2">

License

MIT License, see the LICENSE.md file for details.


Notes

This project is part of my weekly newsletter at sandromaglione.com.

Other static site generators

Development

  • Use npx --loglevel silly .. from example folder to debug npx command

Implementation

Read all the details of the implementation in the full article 👇