SleepingKingStudios::Docs

SleepingKingStudios::Docs provides a CLI and tooling for generating a static website from your YARD documentation, powered by Jekyll.

Documentation

This is the documentation for Version 1.0 of SleepingKingStudios::Docs.

• For the current development build, see Documentation.
• For previous releases, see the Versions page.

Tasks

SleepingKingStudios::Docs uses the thor gem to power its CLI tasks.

Documentation

• docs:generate — Generates the documentation files for each Ruby file in your project.
• docs:update — Updates existing documentation files.

Installation

• docs:install — Installs the Jekyll application.
• docs:install:templates — Installs or updates the Jekyll templates for YARD objects.
• docs:install:workflow — Installs or updates the GitHub actions workflow for deploying to Pages.

Reference

For a full list of defined classes and objects, see Reference.