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

mzord

v1.0.3

Published

A simple component-based HTML build tool

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

joecruz-tvmbjoecruz-tvmb

Keywords

Readme

MEGAZORD is a simple build tool that enables you to convert componentized blocks of html into static pages. This is accomplished by including special <mz-*> HTML tags in your markup, similar to classic ASP/ASP.NET Forms pages.

Getting Started

To use, install using npm.

npm i -g mzord

From the command line, you can call the executable with the following options.

 -i, --init <init>: Generate skeleton files to location specified.
 -f, --file <file>: File to be processed.
 -d, --dir <dir>: Directory to be processed (should be structured as created by `init` command, with a /pages folder).
 -o, --out <out>: Output directory.
 -w, --watch: Watch for changes
 -l, --lang <lang>: Language to be used in processing, eg. "en" or "es". If no language is specified, "en" is assumed.
 -v, --version: Output the current MEGAZORD version

Quick Start

  1. Install using npm as show above
  2. From the command line type mzord --init ./new-project
  3. Take a look at everything under the /pages, /layouts, /blocks, and /lang folders inside ./new-project.

NOTE: WHEN USING THE --DIR OPTION, THE HTML FILES IN /pages ARE THE ONLY ONES THAT WILL BE PROCESSED AUTOMATICALLY.

  1. To build and output the assembled pages, run ./mzord --watch --dir ./new-project --out ./dist. This command will listen for any changes to the source files, and then rebuild the output in the ./dist folder when they are detected.

MEGAZORD tags

There are 5 speciality MEGAZORD tags, explained below. All <mz-*> tags can be either self closed (ie, with />), or just used as an opening tag (eg, <mz-layout src="...">)

<mz-layout src="...">

Only 1 of these tags may be included in a page, and are used to specify a parent template, comparable to the old ASP/.NET Master Pages

<mz-content>

This tag is only to be used in layouts, and specifies where in the layout the page content should go.

<mz-block src="./other-block.html" customName="customValue">

The block tag will copy the file specificed by the src parameter and place its content into the file. Any other parameters will be passed into the included block and can be accessed using an <mz-var> tag.

<mz-var param="...">

The var tag is used to display values passed into a block.

<mz-translate key="...">

The tranlsate tag is used (when --lang is specified and a tranlsation file is provided) to switch between values stored in the lang files. The value given in the key prop must match the string of the identifier in the lang.json file.

Pages vs. Layouts vs. Blocks

Pages - Pages are the primary holders of your HTML. As an example, for a website with three pages (Home, About, Contact Us), there should be three page files (home.html, about.html, contact.html). Pages can specify a single <mz-layout> tag, and can include many <mz-block> and <mz-translate> tags.

Layouts - Layouts can be used to hold shared wrapper code that is used across pages. Only one layout tag can be used per page. They generally hold the boilerplate structure of your site, ie. <html>, <head>, and <body> tags. Layouts use the special <mz-content> tag to specify where the calling page's content will go. Layouts can also include <mz-block> and <mz-translate> tags.

Blocks - Blocks are re-usable snippets of HTML that can be included in Layouts, Pages, or even other Blocks. Any parameters passed into a <mz-block> tag can be accessed within the block HTML by using an <mz-var> tag.

FAQ

  • Can I use a header.html and footer.html block in my pages instead of using an <mz-layout> tag and layout file?
    - Yep!

  • Are translation files required?
    - No, they are not required. If you do not specify a language file, but include <mz-translate> tags in your markup, they will simply be removed during processing.

MIT License

Copyright (c) 2023 Joseph Cruz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.