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

index.md

v0.1.18

Published

Flexible CLI that creates HTMLs from your Markdown files.

Downloads

15

Vulnerabilities

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

Links

Maintainers

amirsavandamirsavand

Keywords

markdownhtmlcliindexconvertmd2html

Readme

index.md

Version

Flexible CLI that creates HTMLs from your Markdown files.

Screenshot

Screenshot 2

Installation

You can install it from npm.

> npm install -g index.md

Usage

The main command converts and with init it generates a config file.

Run

Convert all the .md files to .html files.

> index.md

If the command doesn't work for you and your OS treats it as a file instead of an executable, try this:

> index-md

Options

Here are all the options or configurations for index.md:

  • version Must be set, do not edit this.
  • source Relative path to read your .md files (default is ".").
  • output Relative path to save your converted .html files (default is ".").
  • template Use an HTML template for standard web page (default is true).
  • baseTemplate Relative path to your base HTML template (default is null).
  • nameAsTitle Use MD file name as HTML title (default is false).
  • firstLineAsTitle Use first line of MD file as HTML title (default is true).
  • cssVariables CSS3 Theming of default base template.
    • --primary
    • --body-color
    • --body-bg
    • --heading-color
    • --content-bg
  • extraHead List of custom HTML head elements.
  • headingsId Add IDs to headings.
  • headingsIdSlugify Slugify the heading IDs.

Arguments

Here are all the args or parameters when running index.md command:

  • init Creates the config file with default values for each option.
  • help Prints out this README file.
  • version Prints out the current version.

Custom Base HTML Template

If you don't want the default base HTML template/theme you can make your own. All you need to do is to include certain variables so index.md can use it.

Variables

You need these exact characters in the template, so they work.

  • <!-- TITLE --> (required)
  • <!-- PAGE --> (required)
  • <!-- EXTRA_HEAD --> (optional)
  • <!-- CSS_VARIABLES --> (optional)

Starter Template

Here's a starter template for you base HTML template:

<!doctype html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <!-- EXTRA_HEAD -->
  <title><!-- TITLE --></title>
  <style>
    /* CSS_VARIABLES */
  </style>
</head>
<body>
  <!-- PAGE -->
</body>
</html>

Development

Here are the commands for development:

  • npm run build Compile the TS files to JS.
  • npm run start Run the app.js.
  • npm run lint Check code quality.