Skip to content

metalsmith/awesome-metalsmith

Repository files navigation

Awesome Metalsmith

A curated collection of awesome Metalsmith resources, plugins, examples, and tutorials.

Metalsmith is an extremely simple, pluggable static site generator built with Node.js. It takes files from a source directory, runs them through a series of plugins, and outputs the transformed files to a destination directory.

📚 Documentation

Core Resources

  • Resources - Comprehensive list of Metalsmith community resources including tutorials, blogposts, and site examples
  • Plugins - Catalog of known Metalsmith plugins with health indicators and security analysis
  • Plugin Health Checker - Documentation for the plugin health monitoring system
  • New Plugin Guide - Guide for creating and publishing new Metalsmith plugins

Tutorials

  • Tutorials Overview - Collection of tutorials for learning Metalsmith
    • CLI Tutorials
    • JavaScript API Tutorials
      • Introduction - Introduction to Metalsmith's JavaScript API
      • Plugins - Working with plugins in Metalsmith
      • Templates - Using templates with Metalsmith

🛠️ Plugin Health Monitoring

This repository includes tools for monitoring the health and security status of Metalsmith plugins:

  • Updates of plugin statuses
  • Security vulnerability detection
  • Dependency analysis
  • Activity tracking

Health monitoring tools must be used locally to update PLUGINS.md. The result can then be committed via a pull request.

See Plugin Health Checker for more details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Adding Resources

To add new resources, edit the RESOURCES.md file.

Adding Plugins

To add new plugins, follow the guidelines in NEW_PLUGIN_GUIDE.md.

📄 License

This project is open source and available under the MIT License.

🌟 Support

If you find this resource helpful, please consider giving it a star on GitHub!


Last updated: Aug 2025

About

Resources and examples for Metalsmith

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 13