Git Product home page Git Product logo

cleanslate's Introduction

Clean Slate

What does it do?

Clean Slate is a VSCode extension that looks for XML style comments in your source code (C# at the moment) and converts them to markdown for use with the Slate API documentation system.

Get Started with Clean Slate

Current Commands (Use the Command Pallet Commands)

  • CleanSlate Generate -> Generates the markdown document of the current file you have open in text editor.
  • CleanSlate GenerateProj -> Generates markdown documents for all files in a project.
  • CleanSlate ChangePath -> Change path to where you would like to produce markdown document.
  • CleanSlate ShowPath -> Shows the path that is currently set as default output path.
  • CleanSlate Hide Comment Coverage -> Hides the status bar comment coverage information.
  • CleanSlate Show Comment Coverage -> Shows the status bar comment coverage information.

Dependencies

The markdown file generated is to be used with Slate

The Source code to this extension is available on https://github.com/Liftlock/CleanSlate and licensed under the MIT license.

Developed with love by Liftlock Studios

cleanslate's People

Contributors

shiftay avatar vrajvpatel avatar qcha0s 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.