# yoxel

> Semantic reporting tool

Latest version **0.1.0** (published 2021-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install yoxel
pnpm add yoxel
yarn add yoxel
bun add yoxel
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-11-22 |
| First published | 2021-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 44.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kashey |
| Keywords | html tree, a11y |

## Links

- npm: https://www.npmjs.com/package/yoxel
- npm.io page: https://npm.io/package/yoxel

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.0.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2021-11-22
- 0.0.1-beta — 2021-11-21
- 0.0.0-beta — 2021-11-20

## README

<div align="center">
  <h1>YOXEL</h1>
  <br/>

  <a href="https://www.npmjs.com/package/yoxel">
    <img src="https://img.shields.io/npm/v/yoxel.svg?style=flat-square" />
  </a>

  <a href="https://www.npmjs.com/package/yoxel">
   <img src="https://img.shields.io/npm/dm/yoxel.svg" alt="npm downloads">
  </a>
 <br/>
</div>

# Idea

Inspired and named after [yoksel](https://github.com/yoksel) 's [HTML-tree](https://github.com/yoksel/html-tree).

## API

- `build(htmlNode): SemanticTree` creates a structure representing SemanticTree
- `getYAMLReport(tree: SemanticTree)` converts tree into YML format, useful for shapshot testing

## Purpose

Provide a11y helpers to reflect page structure.

## Usages

- [storybook-addon-poleaxe](https://github.com/theKashey/storybook-addon-poleaxe)

# License

MIT

---
_Source: https://npm.io/package/yoxel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
