Module: SleepingKingStudios::Docs::Jekyll::Plugins::Required

Parent Namespace

SleepingKingStudios::Docs::Jekyll::Plugins

Included Modules

SleepingKingStudios::Docs::Jekyll::Plugins::Liquid::Filters::AnchorizeSlug

Defined In

lib/sleeping_king_studios/docs/jekyll/plugins/required.rb

Table Of Contents

• Overview
• Instance Methods
  • anchorize_slug

Overview

Helper module for loading all required Jekyll plugins.

Back To Top

Instance Methods

#anchorize_slug(slug) => String

Inherited From

SleepingKingStudios::Docs::Jekyll::Plugins::Liquid::Filters::AnchorizeSlug

Converts the slug to a string usable as an HTML anchor.

Certain characters are valid Ruby identifiers but cause issues when used as HTML anchors, such as equals signs, hashes, question marks, and square brackets. This method replaces each with a placeholder value.

Parameters

• slug (String) — the slug to convert.

Returns

• (String) — the converted slug.

Back To Top

---

Back to Documentation | Versions | 0.2 | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Jekyll | SleepingKingStudios::Docs::Jekyll::Plugins