CodeViewer Component

CodeViewer is a lightweight, customizable web component that makes it easy to display beautifully formatted code snippets on your website. It uses Shadow DOM to encapsulate styles, ensuring that the component will not conflict with the rest of your page.

Getting Started

To use CodeViewer in your project, follow these steps:

1. Include the highlight.js library and the code-viewer.js file in your HTML file:

<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/highlight.min.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/gh/t-montes/code-viewer@master/dist/code-viewer.min.js"></script>

2. Use the code-viewer tag in your HTML to display code snippets:

<code-viewer title="main.js">
    console.log("Hello World!");
    // more code here
</code-viewer>

If you want to use an specific version of the component, instead you must import the code-viewer.js file from the versions folder:

<script type="module" src="https://cdn.jsdelivr.net/gh/t-montes/code-viewer@master/versions/<version>/code-viewer.min.js">

Features

• Syntax highlighting via Highlight.js
• Customizable appearance through attributes such as title and font-size
• Automatic indentation handling for cleaner code display
• Copy-to-clipboard functionality for code snippets

Usage

You can customize the appearance and behavior of the CodeViewer component using the following attributes:

• title: Sets the title of the code snippet, which is displayed in the header bar.
• font-size: Adjusts the font size of the code within the viewer.

Example with custom title and font size:

<code-viewer title="main.dart" font-size="1.2rem">
    // code here
</code-viewer>

To style the component globally, you can target the code-viewer element in your CSS:

code-viewer {
    /* styles here */
}

Contributing

Contributions are what makes 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!

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

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• Highlight.js for the syntax highlighting functionality.
• All the developers and contributors who work on open-source projects.
• The web development community for their continual feedback and support.