Giter Club home page Giter Club logo

cfn-docgen-vsc-extension's Introduction

cfn-docgen-vsc-extension README

cfn-docgen-vsc-extension invokes cfn-docgen via visual studio code's interfaces, and makes it easier to generate and preview documents from cfn template files.

Features

  • invoke cfn-docgen command line tool via visual studio code's interfaces.
  • make it easy to preview generated documents.
  • generate resource definition skeleton for each resources

Usage

Generate a single document from a single cfn template

single-dest-from-single-source

Batch generate multiple documents from multiple cfn templates

multi-dest-from-multi-source

Generate skeleton for specified resources type

skeleton

Requirements

This extension is just a wrapper for cfn-docgen. So you need to also install cfn-docgen command line tool.

Extension Settings

This extension contributes the following settings:

  • cfn-docgen.OutputRootDirectory: output root directory for generated documents
  • cfn-docgen.OpenPreview: if true, automatically open markdown preview right after the document is generated
  • cfn-docgen.CustomResourceSpecificationPath: absolute path for your custom resource specification json file
  • cfn-docgen.SkeletonFormat: skeleton format
  • cfn-docgen.Debug: if true, enable debug logging

Known Issues

Release Notes

cfn-docgen-vsc-extension's People

Contributors

tkido1216 avatar

Watchers

horie-t avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.