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

ken-markup

v1.0.3

Published

Markup language for ken-zone

Downloads

19

Readme

ken-markup

ken-markup is a markup language made for family websites of ken-zone.

Here is a demo website of ken-markup (in Korean).

Usage

  1. Install the module

    $ npm i ken-markup
  2. Import the module

    import Translator from 'ken-markup'

    You can import it with a different name (i.e. instead of Translator) if you want.

  3. Translate the text

    translatedText = Translator.translate(originalText);

Features

  • It converts text into HTML elements.
  • It supports enough grammar to write basic articles.
  • It makes an index table and footnotes automatically.
  • Anyone can design it since it returns raw HTML code.

Grammar

  • **bold**

  • //italic//

  • ~~delete~~

  • __under__

  • ^^sup^^

  • ,,sub,,

  • [[link]]

    You can show different text to the text of the link by using |;

    ex) [[link|name]]
    -> name // The href will be the link

    If you want to add some rules to the link text, you can override the parseAnchorLink method of the class.

  • ((note))

    You can set the index of notes as texts by using |.

    ex) ((index|note))
    -> [index] // The content will be the note
  • # title

    Title grammar has five levels which can be changed by the count of #.

    ex)
    # title 1.
    ## title 1.1.
    ## title 1.2.
    # title 2.
  • :[table]:

    Table grammar starts with :[ and ends with ]:.

    To divide columns, insert ][ between the line.

    To divide rows, insert \n][ or ]\n[ into the end of the line that you want to break.

    ex)
    :[cell(0,0)][cell(0,1)
    ][cell(1,0)][cell(1,1)]
    [cell(2,0)][cell(2,1)]:
  • :(unordered list):

    Unordered list grammar starts with :( and ends with ):.

    To divide items, use )(, \n)(, or )\n(. You can use any of these, even mixed.

    ex)
    :(item1
    )(item2)
    (item3)(item4):
  • :{ordered list}:

    The difference between ordered and unordered is only the change from ( to {.

    ex)
    :{item1
    }{item2}
    {item3}{item4}:
  • ---- horizontal rule

    Four - are converted into a horizontal rule, which can be used to separate sections or contents.

    ex)
    ----

    There should be a line break (\n) before this grammar.

  • \ ignoring grammar

    Put the \ character in front of the grammar that you want to ignore.

Further plans

  • Images
  • Font-size
  • Text-align
  • Text-color
  • Indent
  • Quotes
  • Code
  • Math(equations)