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

doc-limp

v1.2.2

Published

lightweight extensible document markup language

Downloads

4

Readme

Limp: the lightweight and extensible document markup language

Run Automated Tests

Limp is a lightweight markup language for creating documents.

Table of Contents

  1. Introduction

Introduction

Limp has only 3 basic rules to markup a document:

  1. Heading
  2. Inline Roles
  3. Block Roles

Roles are the essential part of limp: they mark a text how it means in the document. For instance, the ref role indicates the text is a (hyper-)reference, and the label role denotes the text is a significant point in the document and may be referred to.

Heading

Limp has four levels of headings:

Heading 1
=========

Heading 2
---------

Heading 3
*********

Heading 4
#########

Those are compiled to:

<h1>Heading 1</h1>

<h2>Heading 2</h2>

<h3>Heading 3</h3>

<h4>Heading 4</h4>

h5 and h6 are not supported. But you can add your own custom headings by adding custom roles and renderers.

Inline Roles

Inline role is a way to mark a text with a role. A text segment like :bold:this is bold text; is a very example of inline role. Renderers handle inline roles and block roles, and each of the different roles has a very different display.

Note you can make custom renderers and use them in your project to process your document.

Block Roles

Block role is another way to mark a text with a role. In contrast to inline roles, block roles mark up a chunk of texts.

For example:

::*code~

  This is a example of code block.

::list~

  ::item~

    This is a example of list item.

  ::item~

    This is another example of list item.

Blocks are indicated by an indentation consisting of some spaces (code point 0x20). Note tab characters are not counted and ignored when the limp parser measures the indentation level of a line. When some "dedents" appear and the indentation level turned to the same or less level as the start of the block, it is the end of the block.

The above example are shown like this:

This is a example of code block.
  1. This is a example of list item.

  2. This is another example of list item.

Default Roles

Limp has a default set of some roles:

  1. Image
  2. Line Break
  3. Block Code
  4. Block List
  5. Block Table

Here is a complete table of inline roles and their appearance:

|Role Name|Output|Aliases|Remarks| |:-:|:-:|:-:|:-:| |bold|text|b|| |italic|text|i|| |underlined|text|u|| |strike|~~text~~|s|| |code|text||code role can also be used as a block role.|