Skip to content

Configuration ​

viewmd can be configured with a .viewmd.yaml file in the served directory.

Config File ​

Create a .viewmd.yaml file in the root of the directory you're serving:

yaml
show_all_files: true

Options ​

KeyTypeDescriptionDefault
show_all_filesbooleanShow all files, not just markdownfalse

Precedence ​

CLI flags override config file values. For example, if .viewmd.yaml sets show_all_files: true but you don't pass -a, all files will still be shown. The config file provides a default that applies when no flag is given.

Released under the MIT License.