Discussions

Ask a Question
Back to All

Is there a way to author in VS Code

Our team would like to continue authoring in Visual Studio Code and then let Jenkins pull the guide topics from our Git repository for staging/QA/GA. I did not see a way to add a CLI command to Jenkins or a plugin.

What's the best way to do this? (Lots of details please, we're experienced MD'ers...not ReadmeMD.)

Trying to author in VSC.
Port the stuff up to ReadmeCloud for skinning magic and combining with Swagger on a regular basis.

Admin(edited)

Hey, this is a good question! You can use RDME, our CLI tool, to sync markdown docs up to ReadMe! It works great locally, as part of your CI/CD workflow, or in a GitHub action! (We also have some special markdown features as part of our RDMD engine that you can take advantage of too!)