> For the complete documentation index, see [llms.txt](https://negevvo.gitbook.io/clearlyjs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://negevvo.gitbook.io/clearlyjs/undefined.md).

# ClearlyJS (preview)

Welcome to the official documentation of ClearlyJS!

[![](https://img.shields.io/github/v/release/negevvo/ClearlyJS?color=yellow\&include_prereleases)](https://github.com/negevvo/ClearlyJS/releases/) [![](https://img.shields.io/badge/license-MIT-1abc9c.svg)](https://github.com/negevvo/ClearlyJS/tree/a3cb15715f53e2d784a801abc6ff73c82a82d7a2/LICENSE/README.md) [![](https://img.shields.io/website?down_color=red\&down_message=down\&label=jsDelivr\&up_color=orange\&up_message=up\&url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fnegevvo%2FClearlyJS%40main%2FClearlyJS%2Fclearly.js)](https://cdn.jsdelivr.net/gh/negevvo/ClearlyJS@main/ClearlyJS/clearly.js)

[![Edit ClearlyJS template](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/clearlyjs-template-wrsjv?fontsize=14\&hidenavigation=1\&module=%2Fcode%2Findex.js\&theme=dark)

[**Try the ClearlyJS CodePen template**](https://codepen.io/pen/?template=KKajRxM)

{% hint style="warning" %}
This documentation is still not ready (of course you can read the completed parts and give feedback :)
{% endhint %}

Make it simple! A JavaScript library made for making small-scale apps in no time - and without learning a new language!

**Please note that:**

1\. this is not the final version and things can be changed.

2\. I won't allow any changes to this repo's code (or copying the code from any file in any branch of this repo) until I'll release a final version (will be called 1.0 or something like it, and I'll let you know).

3\. You **can** use the library now (read 1 again!) - put the following in your page's head: `<script src="https://cdn.jsdelivr.net/gh/negevvo/ClearlyJS@main/ClearlyJS/clearly.js"></script>` and write your code with defer.

You can also import ClearlyJS from your js file (Will be available soon): `import clrly from 'https://cdn.jsdelivr.net/gh/negevvo/ClearlyJS@main/ClearlyJS/clearly.js'`

&#x20;A real documentation is coming soon, the completed parts are available here.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://negevvo.gitbook.io/clearlyjs/undefined.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
