Rakuast::RakuDoc::Render examples

=begin rakudoc

AUTHOR

Richard Hainsworth, aka finanalyst

VERSION

v 0.1.0

The power of the RakuDoc specification is that it allows for customisation.

The Rakuast::RakuDoc::Render distribution contains a number of plugins to illustrate the customisation.

Since each of these customisations are included in the Render's distribution, they may all be used in RakuDoc sources.

Blocknames with mixed upper and lower case names are customised, and they should not be expected to exist in other RakuDoc renderers (though no other renderers of RakuDoc v2 currently exist ).

Graphviz

The following is taken from GraphViz.org's gallery .

For more information see Graphviz block The diagram source is included in a Rakudoc source file as:

=begin Graphviz :headlevel(2) :caption<Cluster gradients>
digraph G {bgcolor="#0000FF44:#FF000044" gradientangle=90
	fontname="Helvetica,Arial,sans-serif"
	node [fontname="Helvetica,Arial,sans-serif"]
	edge [fontname="Helvetica,Arial,sans-serif"]

	subgraph cluster_0 {
		style=filled;
		color=lightgrey;
		fillcolor="darkgray:gold";
		gradientangle=0
		node [fillcolor="yellow:green" style=filled gradientangle=270] a0;
		node [fillcolor="lightgreen:red"] a1;
		node [fillcolor="lightskyblue:darkcyan"] a2;
		node [fillcolor="cyan:lightslateblue"] a3;

		a0 -> a1 -> a2 -> a3;
		label = "process #1";
	}

	subgraph cluster_1 {
		node [fillcolor="yellow:magenta"
			 style=filled gradientangle=270] b0;
		node [fillcolor="violet:darkcyan"] b1;
		node [fillcolor="peachpuff:red"] b2;
		node [fillcolor="mediumpurple:purple"] b3;

		b0 -> b1 -> b2 -> b3;
		label = "process #2";
		color=blue
		fillcolor="darkgray:gold";
		gradientangle=0
		style=filled;
	}
	start -> a0;
	start -> b0;
	a1 -> b3;
	b2 -> a3;
	a3 -> a0;
	a3 -> end;
	b3 -> end;

	start [shape=Mdiamond ,
		fillcolor="pink:red",
		gradientangle=90,
		style=radial];
	end [shape=Msquare,
		fillcolor="lightyellow:orange",
		style=radial,
		gradientangle=90];
}
=end Graphviz

Formalas using Latex

Here is an example that uses the block LatexFormula, and more detail can be found at Latex plugin.

Leaflet maps

Here is a map with defaults:

For more examples, see Leaflet maps

Custom markup

The Renderer recognises ℱ<>, where ℱ is U+2131, to access the Fontawesome free icons. See font search page. Make sure to filter for the free icons.

Some FontAwesome icons

ℱ<fas fa-ambulance> Example of ambulance

ℱ<fas fa-car> Example of automobile

ℱ<fas fa-bicycle> Example of bicycle

ℱ<fas fa-bus> Example of bus

ℱ<fas fa-truck> Example of truck

ℱ<fas fa-wheelchair> Example of wheelchair

ℱ<fas fab-accessible-icon> Example of accessible-icon (was wheelchair-alt in fontawesom v4)

Generates Some FontAwesome icons

ℱ<fas fa-ambulance> Example of ambulance

ℱ<fas fa-car> Example of automobile

ℱ<fas fa-bicycle> Example of bicycle

ℱ<fas fa-bus> Example of bus

ℱ<fas fa-truck> Example of truck

ℱ<fas fa-wheelchair> Example of wheelchair

ℱ<fab fa-accessible-icon> Example of accessible-icon (was wheelchair-alt in fontawesome v4)

FontAwesome has some other options.

Train normal size ℱ<fas fa-train> Triple size train ℱ<fas fa-train fa-3x>

An animated spinner ℱ<fas fa-sync fa-spin fa-3x fa-fw>

Generates

Train normal size ℱ<fas fa-train> Triple size train ℱ<fas fa-train fa-3x>

An animated spinner ℱ<fas fa-sync fa-spin fa-3x fa-fw>

=end rakudoc

Elucid8::Build v0.12.10

Renders RakuDoc sources in multiple languages to web site

Authors

  • Richard Hainsworth

License

Artistic-2.0

Dependencies

Rakuast::RakuDoc::RenderRakuConfigPrettyDumpGit::Blame::File

Test Dependencies

Provides

  • Elucid8-Add-ui-lang
  • Elucid8-Build
  • Elucid8-Gather
  • Elucid8::Plugin::HTML::AutoIndex
  • Elucid8::Plugin::HTML::Favicon
  • Elucid8::Plugin::HTML::SiteMap
  • Elucid8::Plugin::HTML::UISwitcher

The Camelia image is copyright 2009 by Larry Wall. "Raku" is trademark of the Yet Another Society. All rights reserved.