To prettify a file: npm run --silent prettify-md < input.md.
To prettify a file and save the output: npm run --silent prettify-md < input.md > output.md.
To check whether a file is prettyfied or not: npm run --silent check-md < input.md. This will fail with an exception and return code 1 if the file is not prettyfied.
Note: the --silent switch sets the npm log level to silent, which is useful to hide the executed file name and concentrate on the actual output.
Formatting with docker
The core formatting logic of the extension is also available as a node docker image: docker pull darkriszty/prettify-md.
Available features from docker:
To prettify a file: docker container run -i darkriszty/prettify-md < input.md.
To prettify a file and save the output: docker container run -i darkriszty/prettify-md < input.md > output.md.
To check whether a file is prettyfied or not: docker container run -i darkriszty/prettify-md --check < input.md. This will fail with an exception and return code 1 if the file is not prettyfied.
Extension Settings
The extension is available for markdown language mode. It can either prettify a selection (Format Selection) or the entire document (Format Document).
A VSCode command called Prettify markdown tables is also available to format the currently opened document.
Configurable settings:
The maximum texth length of a selection/entire document to consider for formatting. Defaults to 1M chars. There is no limit when running from the command line.
Keyboard shortcut to prettify the currently opened markdown document. Default: CTRL+ALT+M (CMD+ALT+M on Mac).
Known Issues
Tables with mixed character widths (eg: CJK) are not always properly formatted (issue #4).