Merge pull request #8 from koculu/update-docs

update docs.

Author: koculu

docs-site/src/content/docs/formatting.md

@@ -22,7 +22,7 @@ type ColorOrColorizer = string | Colorizer
 
 ### colorizeHTML
 
-Colorize small HTML fragments for terminal display.
+Colorize HTML strings.
 
 ```ts
 import { getLogger } from 'logpot'

packages/printer/src/colorizeHTML.ts

@@ -21,20 +21,15 @@ export interface ColorizeHTMLConfig {
 }
 
 /**
- * Colorize an HTML snippet for console output.
- *
- * The function performs a very small amount of parsing using regular
- * expressions and wraps different parts of the HTML string with ANSI
- * colors. It is not a full HTML parser but works well for debugging
- * or visualising small fragments.
+ * Colorize an HTML string for console output. *
  *
  * @param html - raw HTML string to colorize.
  * @param config - optional {@link ColorizeHTMLConfig} to override defaults.
  * @returns the ANSI colored HTML string.
  *
  * @example
  * ```ts
- * console.log(colorizeHTML('<div class="greet">Hi</div>'))
+ * getLogger().debug(colorizeHTML('<div class="greet">Hi</div>'))
  * ```
  */
 export function colorizeHTML(