Giter VIP home page Giter VIP logo

vscode-markdown-it-dokapi's Introduction

VSCode Extension for Dokapi

Automatically includes Markdown Dokapi plugin in vscode markdown rendering

Package largely inspired by Markdown Extended

Route block

&&& [VERB] [path] [description]

Verb can be GET, POST, PUT, PATCH, DELETE

&&& GET /my/path My description

	Random markdown !

	Cool

Response block

&<< [status] [message]

Message will be unparsed if status is success (2xx)

&<< 200

	Response random markdown !

Copy / References

&## [keyword]

Defines a reference with the name keywords. The reference will include everything indented and written below.

&@@ [keyword]

Repeat the block stored in keyword reference

Allows to define responses or errors once and repeat it inside API.

&## error1
	&<< 404 Not Found

&&& GET /test/ Test route

	&<< 200

	&@@ error1

Future features ?

I might add additionnal commands in the future... Feel free to discuss it in issues.

  • Object Model ?
  • Process bloc ?
  • Request bloc ?

vscode-markdown-it-dokapi's People

Contributors

tyrenn avatar

Watchers

 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.