chetan

YARD CHEATSHEET http://yardoc.org

May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e

cribbed from http://pastebin.com/xgzeAmBn

Templates to remind you of the options and formatting for the different types of objects you might want to document using YARD.

Modules

Integralist

#!/usr/bin/env ruby

=begin
    install Sinatra: gem install sinatra
    install Shotgun: gem install shotgun (this auto-reloads sinatra on every http request - which means every time you make a change in your code you don't have to stop then start sinatra)

    To just run your code using Sinatra: ruby name-of-file.rb
    To run your code using Shotgun (which is just Sinatra but with ability to auto-reload when changes are made to files): shotgun name-of-file.rb

    The following examples are run using Shotgun and the URL is: http://127.0.0.1:9393/

kevin-smets

Default

Powerlevel10k

edubkendo

I want to write plugins for Atom's editor in Ruby. Opal makes this possible. Atom is one of several projects in recent times to combine Chromium with Node.js for a desktop app. While it utilizes chromium for it's gui, and boasts "[e]very Atom window is essentially a locally-rendered web page", writing Atom plugins is more like writing a server-side node.js app than a typical single-page client-side app (albeit with really awesome integration with Chrome Devtools). Opal development, on the other hand, has to-date been focused primarily on the browser use-case.

Because of this, I had to make a choice between using the opal-node package from npm, using Opal via Ruby w/ a compile step, or packaging up opal-parser.js, including it with the app, and writing in compilation on the fly. Each choice came with compromises. Using opal-node would have been easiest, just create a top level index.coffee that required opal-node, and then require in your ruby

jerieljan

I use PlantUML a lot. It's what I use for drawing all sorts of diagrams and it's handy because of its easy markup (once you get used to it) while making things easy to maintain as projects grow (thanks to version control)

This gist explains how I do my PlantUML workspace in a project.

• The idea is to keep a globals directory for all diagrams to follow (like the "stylesheet" below) to keep things consistent.
• I use a stylesheet.iuml file that keeps the use of colors consistent through use of basic FOREGROUND, BACKGROUND and ACCENT colors.
• The style-presets.iuml file defines these colors so you can make "presets" or "themes" out of them.
• As stated in the stylesheet.iuml, you'll need the Roboto Condensed and Inconsolata fonts for these to work properly.
• You can choose to either run the PlantUML jar over your file/s, or use an IDE like VSCode with the PlantUML extension. Here's a preview of example-sequence.puml for example: https://imgur.com/Klk3w2F

cstroe

Install Docker on Linux Mint 20.2 Mate Edition

Using the Graphical User Interface (GUI)

1. Click the Linux Mint Menu Button at the bottom left of the screen to open the Linux Mint Menu.
2. Under the "System" section, click "Software Manager".
3. In the Software Manager window, use the search box at the top right and search for "docker".
4. Click on "Docker.io - Linux Container Runtime".
5. Click the green "Install" button at the top right. Enter your administrator password when prompted.
6. Open the Linux Mint Menu again (see step 1), search for "Users and Groups", and click it to open the "User Settings".