0.2.1 • Published 4 months ago

monogon v0.2.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Monogon

2kb <code> block with syntax highlighting meant for the dev environment.

Zero dependencies, support for most frameworks, mildly themable.

Using the CSS Highlight, meaning low browser support.

alt text

!IMPORTANT Monogon is meant for developer tooling and supports very few languages. Think config files.

If you don't need editable code snippets, look at Shiki, it's amazing.

If you need editable snippets, Codemirror might be worth a look.

No SSR support for now.

Supported languages

Languagepropertysyntaxformatting
JSONjson
YAMLyaml
CSScss
plaintextplaintext--

Usage

Import it

import 'monogon';

Use in your HTML as a web component.

<monogon-code lang="json" content='{ "names": ["ian", "ana"], size: "2kb", status: null  }'>Click me</monogon-code>

<script>
  document.querySelector('monogon-code').addEventListener('input', (event) => {
    console.log(event.target.value);
  });
</script>

Frameworks

Vue

import MonogonCode from 'monogon/vue';

const content = ref('{ "json": ["this", "is", "json"], "how": 42  }')
const handleInput = (e) => { content.value = e.target.value }

<MonogonCode :content="content" @input="handleInput">Click me</MonogonCode>

React

import MonogonCode from 'monogon/react';

const content = '{ "json": ["this", "is", "json"], "how": 42  }';
const handleInput = (e) => { console.log(e.target.value) }

<MonogonCode content={content} lang="json" onInput={handleInput} />

Preact

import MonogonCode from 'monogon/preact';

const content = '{ "json": ["this", "is", "json"], "how": 42  }';
const handleInput = (e) => { console.log(e.target.value) }

<MonogonCode content={content} lang="json" onInput={handleInput} />

Svelte

There is no native support yet for Svelte, so the web component needs to be used.

import 'monogon';

<monogon-code {content} lang="json" oninput={handleInput}></monogon-code>

Solid

import MonogonCode from 'monogon/solid';
const handleInput = (e) => { console.log(e.target.value) }

<MonogonCode content={content} lang="json" onInput={handleInput} />

Theming

Monogon comes with a VSCode-like dark and light theme. This theme can be changed by changing the css properties on monogon-code.

The simplest way to do so is:

monogon-el.custom-theme-name {
  --mng-background: #0f0;
  /* ...other changes, see lit below */
}
@media (prefers-color-scheme: dark) {
  monogon-el.custom-theme-name {
    --mng-background: #040;
    /* ...other changes, see lit below */
  }
}

Full list of css properties used:

.default-theme {
  /* Generic */
  --mng-text: #213547;
  --mng-background: #f1f1f1;
  /* Proper highlighting */
  --mng-string: #8b251e;
  --mng-key: #c32b1d;
  --mng-number: #4a845b;
  --mng-boolean: #3716f5;
  --mng-null: #3716f5;
  --mng-comment: #4e862d;
  --mng-curly-brackets: #59913e;
  --mng-square-brackets: #59913e;
  --mng-keyword: #666;
  --mng-dashes: #444;
}

With SSR

SSR is not yet supported, you need to load it in the browser during page load.


Made with 🍕 in Amsterdam.

0.2.1

4 months ago

0.1.2

8 months ago

0.2.0

4 months ago

0.1.4

5 months ago

0.1.3

5 months ago

0.1.1

9 months ago

0.1.0

10 months ago

0.0.1

10 months ago