https://github.com/webreflection/essential-md
An essential markdown-like utility for console logs
https://github.com/webreflection/essential-md
Last synced: over 1 year ago
JSON representation
An essential markdown-like utility for console logs
- Host: GitHub
- URL: https://github.com/webreflection/essential-md
- Owner: WebReflection
- License: isc
- Created: 2020-01-17T16:39:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T10:28:03.000Z (about 2 years ago)
- Last Synced: 2025-04-11T19:09:07.486Z (over 1 year ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 30
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# essential-md
[](https://travis-ci.com/WebReflection/essential-md) [](https://coveralls.io/github/WebReflection/essential-md?branch=master)
**Social Media Photo by [Anastasiia Kamil](https://unsplash.com/@nastyakamil) on [Unsplash](https://unsplash.com/)**
A minimalistic markdown like utility to log:
* headers
* bold text
* underlined text
* dimmed text
* striked text
* lists of items
* quotes
* multi or single line code, to keep its content unaffected
* clear 1 up to N previous lines
* prompt to ask questions (for anything fancier, see [prompts](https://www.npmjs.com/package/prompts))
## API
Every exported method can be used either as function or as template literal tag.
* `emd` to transform content into a string
* `log` to convert and `console.log(...)` the result right away
* `error` to `console.error` a bold red `Error:` in front of the message
* `info` to `console.info` a bold blue `Info:` in front of the message
* `warn` to `console.warn` a bold yellow `Warning:` in front of the message
* `clear` to clear any previous logged line (`clear(1)`, `clear(7)`, ... default `1`)
* `prompt` to ask questions (`prompt('What is your name?').then(...)`)
* `ok` to `console.log` a bold green `OK:` in front of the message
* `blue`, `green`, `red`, and `yellow`, to easily color some part of the text
## Examples
```js
import {log, green, red} from 'essential-md';
// const {log, green, red} = require('essential-md');
log`
# This is a header
With some extra content, plus:
* a ${green`green`} text
* a ${red`red`} text
... and literally **nothing else**
`;
```
## The `essential-md` Markdown flavour
* `# header` or `#header#` to have top header
* `## header` or `## header ##` to have less relevant headers
* `*bold*` or `**bold**` to have bold text
* `_underlined_` or `__underlined__` to have underlined text
* `-dim-` or `--dim--` to have dimmed text (not on Windows though, Windows doesn't understand dimmed text ...)
* `~strike~` or `~~strike~~` to strike the text
* `'''` or 3 backticks to have multi-line code
* single backtick to have inline code
* a line starting with a space and one of these `*+-.` chars to have lists
* a line starting with `>` to quote text
That's all folks!