RunSnip

By Rémino Rem https://remino.net

Small library to run snippets of HTML, CSS, and JavaScript in place.

https://remino.net/runsnip/

• About
• Getting Started
• Usage
• To Do
• Contributing
• License
• Contact

About

RunSnip is a small library that allows you to run snippets of HTML, CSS, and JavaScript in place. Write your code in your HTML page as plain text, and have this library run it on the page for you.

Back to top

Getting Started

You can either clone the repo, download the latest release file, or install it using npm:

# Clone the repo
git clone [e-mail]:remino/runsnip.git

# Install using npm
npm add runsnip

Back to top

Usage

Step 1. Write your code on the page.

<textarea id="html">
	<h1>Hello, World!</h1>
</textarea>

<textarea id="css">
	.red {
		color: red;
	}
</textarea>

<textarea id="js">
	document.querySelector('h1').classList.add('red');
</textarea>

<output id="output"></output>

Step 2. Add the RunSnip element.

<run-snip html="#html" css="#css" js="#js" output="#output"></run-snip>

Step 3. Add the auto-start script.

<script src="runsnip-auto.min.js"></script>

Step 4. Run in!

The "Run In" button will appear on the page. Click it to run the code.

Back to top

To Do

This library is mainly for personal purposes at the moment, but I'd like to expand on it for others to enjoy its benefits.

For others to feel more confident in using this, here are a few things to do:

• Add automated tests. (Not sure how to do that yet.)
• Add better documentation. (There are a few features this library does that is not documented here yet.)
• Add more examples.

Back to top

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Back to top

License

Distributed under the ISC License. See LICENSE.txt for more information.

Back to top

Contact

Rémino Rem https://remino.net/

Back to top