Giter Club home page Giter Club logo

pscloudsmith's Introduction

PSCloudsmith

PowerShell wrapper for Cloudsmith API

Building the module

Run ./build.ps1 -Build from the repository root

A fresh copy of the module will be placed in Output\Cloudsmith

Testing the module

Run Import-Module ./Output/PSCloudSmith/PSCloudsmith.psd1 -Force Verify with Get-Command -Module PSCloudSmith

Make sure you run Connect-CloudsmithInstance before attempting any other commands!

Creating docs

  1. Install PlatyPS PowerShell module: Install-Module PlatyPS -Force

  2. Install mkdocs: choco install mkdocs -y or brew install mkdocs on MacOS

  3. Generate markdown docs:

    Easy Way: Import-Module ./Output/PSCloudsmith/PSCloudsmith.psd1 -Force ; New-MarkdownHelp -Module PSCloudsmith -OutputFolder ./docs/

    More structured way:

    Import-Module ./Output/PSCloudsmith/PSCloudsmith.psd1 -Force
    Get-Command -Module PSCloudsmith | Where-Object Name -match 'Repository' | Foreach-Object {
    New-MarkdownHelp -Command $_.Name -OutputFolder ./docs/Repository/
    }

Rinse and repeat for each type of function

Testing docs site locally, and Deploying to GitHub Pages

  1. Build site locally: mkdocs serve
  2. Publish docs to GitHub Pages: mkdocs gh-deploy

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.