Question 1

How do I set up mdsf with GitHub Actions?

Accepted Answer

Use the official hougesen/mdsf GitHub Action to install mdsf, then install required formatters separately in your workflow. Run mdsf format on markdown files and commit changes using tools like add-and-commit, as shown in the README example.

Question 2

mdsf or prettier for formatting code in markdown?

Accepted Answer

mdsf specializes in applying language-specific formatters to code blocks within markdown, while prettier formats entire markdown files including prose. Choose mdsf for precise code style enforcement; prettier for overall document consistency.

Question 3

How to enable caching in mdsf?

Accepted Answer

Add the --cache flag when running mdsf format to cache results. Use mdsf cache-prune to remove old caches, which improves performance on repeated runs but requires manual management.

Question 4

Can mdsf format code in Jupyter notebooks?

Accepted Answer

No, mdsf only works with markdown files. For Jupyter notebooks, you'd need to extract markdown cells or use a dedicated tool that supports .ipynb files, as mdsf focuses on fenced code blocks.

Question 5

What if a language isn't in mdsf's supported tools list?

Accepted Answer

Define a custom tool in the configuration file by specifying the binary, arguments, and stdin settings. Use $PATH as a placeholder for the file path to integrate unsupported languages.

Question 6

How to chain multiple formatters for one language?

Accepted Answer

In the mdsf config file, list tools as an array under the language key, e.g., "python": ["black", "isort"]. mdsf runs them in sequence, and you can nest arrays for fallback options.

Question 7

Is mdsf suitable for large documentation repositories?

Accepted Answer

Yes, with caching and multi-threading, mdsf handles large file sets efficiently. However, ensure all external tools are installed and configured to avoid performance issues or missing dependencies.

mdsf

What is mdsf?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions