# docusaurus-theme-jarle-codeblock

> A Docusaurus theme for editable live code examples using JARLE.

Latest version **1.7.4** (published 2023-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install docusaurus-theme-jarle-codeblock
pnpm add docusaurus-theme-jarle-codeblock
yarn add docusaurus-theme-jarle-codeblock
bun add docusaurus-theme-jarle-codeblock
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.4 |
| Published | 2023-07-03 |
| First published | 2021-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 39.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 4Catalyzer |
| Maintainers | monastic.panic |

## Links

- npm: https://www.npmjs.com/package/docusaurus-theme-jarle-codeblock
- Repository: https://github.com/jquense/docusaurus-plugins
- Homepage: https://github.com/jquense/docusaurus-plugins#readme
- Issues: https://github.com/jquense/docusaurus-plugins/issues
- npm.io page: https://npm.io/package/docusaurus-theme-jarle-codeblock

## Dependencies (4)

- [clsx](https://npm.io/package/clsx.md) ^1.2.1
- [jarle](https://npm.io/package/jarle.md) ^2.0.0
- [es-module-lexer](https://npm.io/package/es-module-lexer.md) ^1.1.0
- [unist-util-flatmap](https://npm.io/package/unist-util-flatmap.md) ^1.0.0

## Recent versions

- 1.7.4 (latest) — 2023-07-03
- 1.7.3 — 2022-11-28
- 1.7.2 — 2022-11-21
- 1.7.1 — 2022-11-21
- 1.7.0 — 2022-08-10
- 1.6.0 — 2022-01-18
- 1.4.0 — 2021-08-06
- 1.2.0 — 2021-07-23
- 1.1.1 — 2021-06-14
- 1.1.0 — 2021-06-14
- 1.0.3 — 2021-02-02
- 1.0.1 — 2021-01-29

## README

# docusaurus-theme-jarle-codeblock

A Docusaurus theme for editable live code examples using JARLE.

## Usage

Install

```sh
npm install docusaurus-theme-jarle-codeblock
```

Modify your `docusaurus.config.js`

```js
module.exports = {
  ...
+ themes: ['docusaurus-theme-jarle-codeblock'],
  presets: ['@docusaurus/preset-classic']
  ...
}
```

Example in your markdown

````
```jsx live
function Clock(props) {
  const [date, setDate] = useState(new Date());
  useEffect(() => {
    var timerID = setInterval(() => tick(), 1000);

    return function cleanup() {
      clearInterval(timerID);
    };
  });

  function tick() {
    setDate(new Date());
  }

  return (
    <div>
      <h2>It is {date.toLocaleTimeString()}.</h2>
    </div>
  );
}
```
````

## Handling local imports

By default `import` statements in a JARLE codeblock will use native
ESM imports, which lets you use dependencies from online repositories like
[skypack](https://www.skypack.dev/).

If you want to use _local_ dependencies bundling with your app instead, a "remark" plugin
is provided to do some processing on Markdown code blocks to enable this.

Modify your `docusaurus.config.js`

```js
module.exports = {
  themes: ['docusaurus-theme-jarle-codeblock'],
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
+          remarkPlugins: [require('docusaurus-theme-jarle-codeblock/remark')],
        },
        blog: {
+          remarkPlugins: [require('docusaurus-theme-jarle-codeblock/remark')],
        },
      },
    ],
  ],
  ...
};
```

This allows codeblocks like the following:

````
```jsx live
  import Button from '@site/src/components/Button';

  <Button>My Button</Button>
```
````

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