Code Monkey home page Code Monkey logo

html-escaped's Introduction

Build Status npm version

HTML Escaped

Micro utility package for escaping coded HTML blocks.

The script can be used automatically using a class reference or manually using JavaScript code on the fly.

A common usage for this type of escaping is documenting HTML within HTML pages without relying on server side rendering. The library manages whitespace before the desired nodes so that pre/code blocks can be used and no further work is required to have the desired output.

Usage

Automatically

Consider the following example for an outer div with an inner div that requires escaping. By declaring html-escaped-code-block the entire tree from that node downwards will be broken into escaped character format.

<div class="container">
    <div class="inner-class html-escaped-code-block">
        <section></section>
        <section></section>
        <section></section>
        <section></section>
    </div>
</div>

Turns into

<div class="container">
    <div class="inner-class html-escaped-code-block">
        &lt;section&gt;&lt;/section&gt;
        &lt;section&gt;&lt;/section&gt;
        &lt;section&gt;&lt;/section&gt;
        &lt;section&gt;&lt;/section&gt;
    </div>
</div>

Manually

// Will escape the entire body of the document
HTMLEscape.do(document.body);


// Will escape the html for and including the div with some id
HTMLEscape.do(document.getElementById('some-id-on-an-element'));

html-escaped's People

Contributors

kmjbyrne avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.