MishkaDocument.Plugins.ContentComponents (Mishka Document v0.0.1)

Copy Markdown View Source

Tells a site's stylesheet which components its documentation's text draws, which icons it names and which classes it writes, through the runtime:compile:content_components hook MishkaCmsCore.Runtime.Compilers.TailwindCompiler.content_components/1 fires while it builds a site's stylesheet: the names the site's approved pages and notes list in content_components, the icon classes they list in content_icons and the classes they list in content_classes, which MishkaDocument.Resources.Changes.ContentFacts stores when either is written. The kit's doc-section, which draws both with rich_content, then reaches those components (MishkaCmsCore.Runtime.Compilers.CssClosure), the stylesheet carries a rule for each icon, and it is built with each class.

Read as the system, as the sitemap reads them (MishkaDocument.Plugins.SitemapUrls): a page locked to some readers draws its components, icons and classes for them, so it counts. Only the rows that name a component, an icon or a class are read, and only those columns.

And the block only the bar under the header draws, doc-switcher (MishkaDocument.Plugins.PageFrame): no page or layout names it, so nothing else would bring its classes into the stylesheet. Registered in MishkaDocument.Application.

Summary

Functions

Returns a specification to start this module under a supervisor.

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

Callback implementation for MishkaInstaller.Event.Hook.get/0.

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

Callback implementation for MishkaInstaller.Event.Hook.register/0.

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

Callback implementation for MishkaInstaller.Event.Hook.start/0.

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

okey_return()

@type okey_return() :: {:ok, struct() | map() | module() | [any()]}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config()

@spec config() :: keyword()

config(key)

@spec config(atom()) :: any()

enable()

@spec enable() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

@spec get() :: keyword()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

@spec health_check() :: :ok | {:degraded, term()} | {:error, term()}

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

on_dependency_error(error)

@spec on_dependency_error(term()) :: term()

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

@spec register() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

@spec restart() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

@spec start() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])

stop()

@spec stop() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

@spec unregister() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.