mirror of
https://github.com/MillironX/Kelpie.jl.git
synced 2024-11-14 21:43:10 +00:00
19 lines
7.6 KiB
HTML
19 lines
7.6 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Kelpie.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://MillironX.github.io/Kelpie.jl/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Kelpie.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MillironX/Kelpie.jl/blob/master/docs/src/index.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><!– markdownlint-disable first-line-heading –></p><h1 id="Kelpie"><a class="docs-heading-anchor" href="#Kelpie">Kelpie</a><a id="Kelpie-1"></a><a class="docs-heading-anchor-permalink" href="#Kelpie" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/MillironX/Kelpie.jl">Kelpie</a>.</p><ul><li><a href="#Kelpie.html-Tuple{Any}"><code>Kelpie.html</code></a></li><li><a href="#Kelpie.html_element"><code>Kelpie.html_element</code></a></li><li><a href="#Kelpie.link_or_text!-Tuple{Any, Any}"><code>Kelpie.link_or_text!</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="Kelpie.html-Tuple{Any}" href="#Kelpie.html-Tuple{Any}"><code>Kelpie.html</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">html(content)</code></pre><p>Creates a new HTML document filled with <code>content</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MillironX/Kelpie.jl/blob/bfcd46caf8eeaabe53fe86d45ef4ea08af23860e/src/Kelpie.jl#L134-L138">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Kelpie.html_element" href="#Kelpie.html_element"><code>Kelpie.html_element</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">html_element(name, content=nothing; kwargs...)</code></pre><p>Creates a new <code>EzXML.Node</code> with name <code>name</code>, containing <code>content</code>, and with attributes specified by <code>kwargs</code>.</p><p><strong>Example</strong></p><pre><code class="nohighlight hljs">julia> import EzXML: prettyprint
|
||
|
||
julia> prettyprint(html_element("img"; src="https://millironx.com/images/charolette.jpg"))
|
||
<img src="https://millironx.com/images/charolette.jpg"/>
|
||
|
||
julia> prettyprint(html_element("span", "MillironX"; class="label-primary"))
|
||
<span class="label-primary">MillironX</span></code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MillironX/Kelpie.jl/blob/bfcd46caf8eeaabe53fe86d45ef4ea08af23860e/src/Kelpie.jl#L102-L119">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Kelpie.link_or_text!-Tuple{Any, Any}" href="#Kelpie.link_or_text!-Tuple{Any, Any}"><code>Kelpie.link_or_text!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">link_or_text!(node, content)</code></pre><p>Converts <code>content</code> to an <code>EzXML.TextNode</code> if it isn't already an <code>EzXML.Node</code> and links it to <code>node</code>. Will link all nodes in <code>content</code> if content is a vector.</p><pre><code class="language-julia-repl hljs">julia> import EzXML: ElementNode, prettyprint; import Kelpie: link_or_text!
|
||
|
||
julia> prettyprint(link_or_text!(ElementNode("div"), ElementNode("br")))
|
||
<div>
|
||
<br/>
|
||
</div>
|
||
|
||
julia> prettyprint(link_or_text!(ElementNode("h1"), "Kelpie.jl"))
|
||
<h1>Kelpie.jl</h1>
|
||
|
||
julia> prettyprint(link_or_text!(ElementNode("div"), ["The end", ElementNode("hr")]))
|
||
<div>The end<hr/></div></code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MillironX/Kelpie.jl/blob/bfcd46caf8eeaabe53fe86d45ef4ea08af23860e/src/Kelpie.jl#L63-L83">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.15 on <span class="colophon-date" title="Monday 4 April 2022 22:43">Monday 4 April 2022</span>. Using Julia version 1.7.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|