Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

adding an introduction page #65

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adding an introduction page #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions html/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,47 @@
# Introduction

Welcome to the KitaJS HTML Engine documentation! The KitaJS HTML Engine offers a
powerful and efficient way to generate HTML content within your KitaJS-powered
applications. Designed to work seamlessly with TypeScript, it leverages JSX/TSX
syntax to create dynamic and interactive web pages effortlessly.

## What is the HTML Engine?

The HTML Engine in KitaJS allows you to harness TypeScript to craft HTML
templates, simplifying the process of building and managing web content. Key
features include:

- **JSX/TSX Support**: Utilize JSX/TSX syntax to write HTML templates, making it
familiar for those with React experience.
- **Automatic Sanitization**: Integrated mechanisms to guard against XSS
(Cross-Site Scripting) attacks, ensuring your web pages are secure.
- **Configuration Flexibility**: Tailor how the engine processes and renders
HTML content to meet your specific needs.
- **Integration Capabilities**: Seamlessly integrate with other parts of the
KitaJS ecosystem and external libraries.

## Why Use the HTML Engine?

Here’s why the HTML Engine is a great choice:

- **Declarative Syntax**: JSX/TSX syntax provides a clean and readable way to
define your HTML structure, enhancing maintainability.
- **Enhanced Security**: Built-in features address common security issues like
XSS, keeping your application safe.
- **Seamless Integration**: Works effortlessly with KitaJS and Fastify, ensuring
a smooth fit for your HTML templates.

## Getting Started

Ready to dive in? Follow the instructions in the
[Configuration](./configuration.md) section to set up the HTML Engine. You'll
get detailed guidance on installing packages, configuring TypeScript, and
integrating the engine into your application.

## Learn More

Discover more about the HTML Engine and its advanced features by exploring the
documentation.

For any questions or support, visit our
[Repository](https://github.com/kitajs/kitajs) for assistance.