# pretty-markup

> Imagine crafting elegant, semantic HTML structures without the clutter of angle brackets. Pretty Markup, a revolutionary preprocessor like Sass for CSS or TypeScript for JavaScript, Pretty Markup takes HTML to the next level.

Latest version **1.0.13** (published 2024-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install pretty-markup
pnpm add pretty-markup
yarn add pretty-markup
bun add pretty-markup
```

Provides the command `pm`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.13 |
| Published | 2024-07-26 |
| First published | 2023-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 38.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Matheus Pires |
| Maintainers | mopires |
| Keywords | frontend, css, html, sass, preprocessor, style, clean code, design, html5, frontend development, scss |

## Links

- npm: https://www.npmjs.com/package/pretty-markup
- Repository: https://github.com/mopires/pretty-markup
- Homepage: https://github.com/mopires/pretty-markup#readme
- Issues: https://github.com/mopires/pretty-markup/issues
- npm.io page: https://npm.io/package/pretty-markup

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [pretty](https://npm.io/package/pretty.md) ^2.0.0
- [prettier](https://npm.io/package/prettier.md) ^3.2.5

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.0.13 (latest) — 2024-07-26
- 1.0.12 — 2024-07-25
- 1.0.11 — 2024-07-23
- 1.0.10 — 2024-07-20
- 1.0.9 — 2024-07-20
- 1.0.8 — 2024-07-20
- 1.0.7 — 2024-05-06
- 1.0.6 — 2024-05-06
- 1.0.5 — 2024-05-06
- 1.0.4 — 2024-03-29
- 1.0.3 — 2023-11-24
- 1.0.2 — 2023-06-05
- 1.0.1 — 2023-06-04
- 1.0.0 — 2023-06-04
- 0.0.2 — 2023-06-01
- … 1 more at https://npm.io/package/pretty-markup/versions

## README

## Pretty Markup: Write HTML Like Poetry

Imagine crafting elegant, semantic HTML structures without the clutter of angle brackets (really human-friendly).  Pretty Markup, a revolutionary preprocessor like Sass for CSS or TypeScript for JavaScript, Pretty Markup takes HTML to the next level.

## Why Pretty Markup?

* **Goodbye `< >`, Hello Readability:** Pretty Markup reimagines HTML syntax, potentially using a more natural language-like approach. This could make writing HTML a breeze, boosting developer productivity.
* **Semantic Powerhouse:**  Focus on the meaning of your content, not just its presentation. Pretty Markup encourage semantic best practices, ensuring your HTML is not only beautiful but also machine-readable.
* **A Superset of HTML?**  Think of it as a layer on top of regular HTML. Write clean, concise code in Pretty Markup, and it seamlessly translates into standard, browser-compatible HTML under the hood. It represents a potential future where writing HTML is an expressive and enjoyable experience.

![Pretty Markup](https://raw.githubusercontent.com/mopires/pretty-markup/main/assets/gif/intellisense.gif)

## Get started 

###  Project use (manual)
1. Create a folder __./src__.
2. Create the files with the extension `.pm`
3. Then, run:

```bash
  pm 
```

> To use the `pm` command, install it globally. Or, use `npx pm`

## Programmatic use
```ts
  import { compiler } from 'pretty-markup';
  const pm = "h1 \"Hey! This's a Heading 1\" /h1"
  const html = compiler(pm)
  console.log(html);

  // Output
  // <!DOCTYPE html>
  // <h1>
  //   Hey! This's a Heading 1</h1>
  //
```


## Official syntax highlighter 
- **Pretty Markup Language Basics** is available to installation on [VS code]("https://marketplace.visualstudio.com/items?itemName=mopires.pretty-markup-language-basics") you can search for `Pretty Markup` and install the extension. Open VSCode and type ctrl+P, type this:

```bash
  ext install mopires.pretty-markup-language-basics
```

### How to Contribute 
We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on how you can help improve the project.

### Issues and improvements 
Report bugs or improvements at https://github.com/mopires/pretty-markup/issues

### ⚖️ License 
This project is licensed under the [MIT License](LICENSE.txt).

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