Skip to content

Commit 1116fb6

Browse files
yesw2000sebastiaanspeckemmanuel-ferdmandmmqzManagor
authored
mcat: add page (#20081)
Co-authored-by: Sebastiaan Speck <[email protected]> Co-authored-by: Emmanuel Ferdman <[email protected]> Co-authored-by: Dylan <[email protected]> Co-authored-by: Managor <[email protected]>
1 parent 75b32ec commit 1116fb6

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

pages/common/mcat.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# mcat
2+
3+
> Parse, convert, and preview files (including Markdown), directories, images, and videos.
4+
> More information: <https://github.com/Skardyy/mcat#example-usage>.
5+
6+
- Display the contents of a file:
7+
8+
`mcat {{path/to/file}}`
9+
10+
- Display a Markdown file with a specific theme:
11+
12+
`mcat {{[-t|--theme]}} {{theme_name}} {{path/to/file.md}}`
13+
14+
- Display an image or video inline:
15+
16+
`mcat {{[-i|--output inline]}} {{path/to/file}}`
17+
18+
- Convert a file to a specific format (e.g. `html`, `md`, `image`):
19+
20+
`mcat {{[-o|--output]}} {{format}} {{path/to/file}}`
21+
22+
- List the contents of a directory:
23+
24+
`mcat {{path/to/directory}}`
25+
26+
- List the contents of a directory, including hidden files:
27+
28+
`mcat {{[-a|--hidden]}} {{path/to/directory}}`
29+
30+
- Display content without paging:
31+
32+
`mcat {{[-P|--paging never]}} {{path/to/file}}`

0 commit comments

Comments
 (0)