Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danburzo/trimd
Convert between HTML, Markdown, and plain text from the command line.
https://github.com/danburzo/trimd
cli html markdown
Last synced: 24 days ago
JSON representation
Convert between HTML, Markdown, and plain text from the command line.
- Host: GitHub
- URL: https://github.com/danburzo/trimd
- Owner: danburzo
- License: mit
- Created: 2023-02-17T22:48:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-16T07:53:30.000Z (7 months ago)
- Last Synced: 2024-04-28T02:42:28.080Z (7 months ago)
- Topics: cli, html, markdown
- Language: JavaScript
- Homepage: https://danburzo.ro/projects/trimd/
- Size: 537 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trimd
Convert between HTML, Markdown, and plain text from the command line.
An online companion tool is available at [**danburzo.ro/trimd**](https://danburzo.ro/trimd/).
## Getting started
Install `trimd` globally using `npm`:
```bash
npm install -g trimd
```
Or run `trimd` on the fly using `npx`:
```bash
npx trimd markdown my-file.html
```
## Usage
```bash
trimd [command] [options] [file1, [file2, …]]
```
Trimd accepts one or more input files, or uses the standard input (`stdin`) when no files are provided. You can also concatenate `stdin` in addition to other input files using the `-` operator.
A couple of general options are available:
- **`-h, --help`** - output help information.
- **`-v, --version`** - output program version.
- **`--silent`** - suppress the output of commands.
By default, the results of processing the operands are concatenated to `stdout`. Use the `--write` option to write the results back to their respective original files.
Below is a list of supported commands.
### `trimd markdown`
Convert HTML to Markdown.
```bash
trimd markdown my-file.html
```
You can pass your own preferences for generating Markdown with options in the form **`--md.=`**, which will get forwarded to [`remark-stringify`](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify):
```bash
trimd markdown --md.strong='*' my-file.html
```
These are the default Markdown options:
```js
const MD_DEFAULTS = {
fences: true,
emphasis: '_',
strong: '_',
resourceLink: true,
rule: '-'
};
```
### `trimd markup`
Convert Markdown to HTML.
```bash
trimd markup my-file.md
```
This command ignores any YAML/TOML front-matter data present in the source file.
Use the `--data-url` flag to output the HTML as a base64-encoded `data:` URL. This format can be useful for viewing the HTML content in a browser:
```bash
trimd markup --data-url my-file.md | xargs open -a Firefox
```
> Note that at the time of writing, Firefox does not immediately render `data:` URLs passed from the command line (you need to press Return in the URL bar). See [#1892289](https://bugzilla.mozilla.org/show_bug.cgi?id=1892289), which is in the process of being fixed.
Use the `--no-sanitize` flag to skip the HTML sanitization step. Sanitization should only be disabled when the Markdown input is known to be safe.
### `trimd remarkup`
Simplify HTML by converting it to Markdown and back. The command is more or less the equivalent of `trimd markdown | trimd markup`.
Use the `--data-url` flag to output the HTML as a base64-encoded `data:` URL.
Use the `--no-sanitize` flag to skip the HTML sanitization step. Sanitization should only be disabled when the HTML input is known to be safe.
### `trimd remarkdown`
Convert Markdown to Markdown. The command accepts the same options as `trimd markdown`.
```bash
trimd remarkdown my-file.md
```
The `trimd remarkdown` command is useful for converting Markdown that may contain raw HTML into the Markdown style specified with the `--md.=` options.
This command preserves any YAML/TOML front-matter data present in the source file.
You can transform the Markdown output by providing a transform function specified in an external JavaScript file and passed via the `-t ` or `--transform=` option.
```bash
trimd remarkdown --transform=exclamation.js my-input.md
```
```js
// File: exclamation.js
export default function exclamation(visit) {
return function transform(tree, file) {
visit(tree, 'text', function (node, index, parent) {
node.value += '!';
});
};
}
```
The default export of your transformer will receive a reference to the `visit` function from the [`unist-util-visit`](https://github.com/syntax-tree/unist-util-visit) package. This is provided as a convenience, you can use it or write your own processing logic.
This export must return a function that transforms the [MDAST tree](https://github.com/syntax-tree/mdast) passed as the first argument. See [`unified.use(Plugin)`](https://github.com/unifiedjs/unified?tab=readme-ov-file#plugin) for more details.
### `trimd demarkdown`
Convert Markdown to plain text.
```bash
trimd demarkdown my-file.md
```
This command ignores any YAML/TOML front-matter data present in the source file.
### `trimd demarkup`
Convert HTML to plain text.
```bash
trimd demarkup my-file.html
```
Plain text is produced according to the algorithm for [`HTMLElement.innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText).
You can also convert HTML to plain text via Markdown by piping `markdown` and `demarkdown` commands:
```bash
trimd markdown my-file.html | trimd demarkdown
```
## Acknowledgements
Trimd is a command-line interface on top of a chain of [unified.js](https://unifiedjs.com) libraries.
## See also
- [Clipboard Inspector](https://github.com/evercoder/clipboard-inspector), a tool to help you explore the kinds of data available when you paste something on a web page, or drop something onto it.
- [percollate](https://github.com/danburzo/percollate), a command-line tool to turn web pages into beautiful, readable PDF, EPUB, or HTML docs.
- [hred](https://github.com/danburzo/hred), extract data from HTML (and XML) from the command line, using a syntax inspired by CSS selector.
- [yamatter](https://github.com/danburzo/yamatter), inspect and transform YAML frontmatter data from the command line.