Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>yaml-readmeNew to Visual Studio Code? Get it now.
yaml-readme

yaml-readme

linuxsuren

|
1,180 installs
| (1) | Free
A helper to generate the READE file automatically.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

This plugin could help you to maintain a complex README file.

Prerequisite

Before get started, please install yaml-readme to you system. You can use hd or others.

hd i yaml-readme

Get started

Put the following code in the first line of the Go template file:

#!yaml-readme -p 'data/financing/*.yaml' --output financing.md

See also this example file.

then press Ctrl+Shift+P and type yaml-readme command to generate the Markdown file specific with --output.

Publish

Please see the following steps to publish this plugin:

  • Login with vsce login linuxsuren
  • Package with vsce package
  • Publish with vsce publish

See also the details.

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft