@manototh/do11y 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +62 -0
- package/dist/do11y.js +1099 -0
- package/dist/do11y.min.js +1 -0
- package/examples/do11y-config.example.js +40 -0
- package/examples/sync-do11y-to-docs.yml +100 -0
- package/package.json +34 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Mano Toth
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Do11y
|
|
2
|
+
|
|
3
|
+
> Originally derived from [github.com/axiomhq/do11y](https://github.com/axiomhq/do11y)
|
|
4
|
+
|
|
5
|
+
Do11y is a documentation observability tool. It streams behavioral events from your docs site to [Supabase](https://supabase.com) (or any HTTP endpoint) in real time:
|
|
6
|
+
|
|
7
|
+
- Page views
|
|
8
|
+
- Scroll depth
|
|
9
|
+
- Link clicks
|
|
10
|
+
- Search queries
|
|
11
|
+
- Code-block copies
|
|
12
|
+
- Section reading time
|
|
13
|
+
- Tab switches
|
|
14
|
+
- Table of contents (TOC) usage
|
|
15
|
+
- Feedback widget usage
|
|
16
|
+
- Expand/collapse interactions
|
|
17
|
+
|
|
18
|
+
Do11y is built for humans and machines alike. It emits observability data designed to be easy to use for human users, while also being easy to query and analyze for machines.
|
|
19
|
+
|
|
20
|
+
Do11y is agent-native: it detects AI platform referrers (ChatGPT, Perplexity, Claude, Gemini, and others) so you can understand how agents and humans engage with your content differently.
|
|
21
|
+
|
|
22
|
+
The runtime artifact is a single dependency-free JavaScript file. The source is TypeScript (`src/do11y.ts`). [rolldown](https://rolldown.rs) produces the built output.
|
|
23
|
+
|
|
24
|
+
## Privacy
|
|
25
|
+
|
|
26
|
+
Do11y collects anonymous usage data:
|
|
27
|
+
|
|
28
|
+
- No cookies. Do11y uses `sessionStorage`, which the browser clears when it closes.
|
|
29
|
+
- No personally identifiable information (PII).
|
|
30
|
+
- No device fingerprinting.
|
|
31
|
+
- No cross-site tracking.
|
|
32
|
+
|
|
33
|
+
Because Do11y uses no cookies and collects no personal data, it doesn't trigger consent requirements under GDPR's cookie rules or CCPA's personal information provisions. You usually don't need a GDPR consent banner for using Do11y. If your organization has specific compliance obligations, verify with your legal team.
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## Supported frameworks
|
|
37
|
+
|
|
38
|
+
Do11y supports the latest versions of the following frameworks:
|
|
39
|
+
|
|
40
|
+
- Mintlify
|
|
41
|
+
- Docusaurus
|
|
42
|
+
- Nextra
|
|
43
|
+
- MkDocs Material
|
|
44
|
+
- VitePress
|
|
45
|
+
|
|
46
|
+
For other frameworks, use manual setup with custom selectors.
|
|
47
|
+
|
|
48
|
+
## Setup
|
|
49
|
+
|
|
50
|
+
Follow the [get started guide](https://docservable.com/get-started) to set up Do11y.
|
|
51
|
+
|
|
52
|
+
## Configuration
|
|
53
|
+
|
|
54
|
+
You can set all options via `window.Do11yConfig` or meta tags. See the [configuration docs](https://docservable.com/configuration) for the full reference.
|
|
55
|
+
|
|
56
|
+
## Insights
|
|
57
|
+
|
|
58
|
+
Get AI-powered recommendations about what to fix. See the [insights docs](https://docservable.com/insights) for more information.
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
[MIT](LICENSE)
|