Packages
indieweb
0.0.32
0.0.66
0.0.65
0.0.64
0.0.63
0.0.62
0.0.61
0.0.60
0.0.59
0.0.58
0.0.56
0.0.55
0.0.54
0.0.53
0.0.51
0.0.50
0.0.49
0.0.48
0.0.47
0.0.46
0.0.42
0.0.41
0.0.40
0.0.39
0.0.38
0.0.37
0.0.36
0.0.35
0.0.34
0.0.33
0.0.32
0.0.31
0.0.30
0.0.29
0.0.28
0.0.27
0.0.26
0.0.25
0.0.24
0.0.23
0.0.22
0.0.21
0.0.20
0.0.19
0.0.17
0.0.16
0.0.15
0.0.14
0.0.13
0.0.12
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.3
0.0.2
0.0.1
Collection of common IndieWeb utilites like authorship resolution, Webmention, post type discovery and IndieAuth.
Current section
Files
Jump to
Current section
Files
priv/dist/doc/IndieWeb.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.19.3">
<title>IndieWeb — IndieWeb v0.0.31</title>
<link rel="stylesheet" href="dist/html-399e30b9b028e3059575.css" />
<link rel="canonical" href="https://hexdocs.pm/indieweb/IndieWeb.html" />
<script src="dist/sidebar_items-23b3c70799.js"></script>
<script async src="dist/html-399e30b9b028e3059575.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<button class="sidebar-button night-mode-toggle">
<span class="icon-theme" aria-hidden="true"></span>
<span class="sr-only">Toggle Theme</span>
</button>
<section class="sidebar">
<a href="https://indieweb.org/" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
IndieWeb </h1>
<h2 class="sidebar-projectVersion">
v0.0.31
</h2>
</div>
<img src="assets/logo.png" alt="IndieWeb" class="sidebar-projectImage">
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">IndieWeb v0.0.31</small>
IndieWeb
<a href="https://git.jacky.wtf/indieweb/elixir" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>The IndieWeb is a people-focused alternative to the "corporate web". </p>
<p>This library provides common facilities for handling interactions and
logic in the IndieWeb space. For more information; check out the open
Wiki over at <a href="https://indieweb.org">https://indieweb.org</a>.</p>
<h2 id="module-configuration" class="section-heading">
<a href="#module-configuration" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Configuration
</h2>
<p>This library makes a lot of network and caching requests. In order to
keep the core implementation light, <code class="inline">indieweb</code> provides a few adapters
that one can set as the default one of choice for the library to use.</p>
<h3 id="module-adapters" class="section-heading">
<a href="#module-adapters" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Adapters
</h3>
<p>You can update the accompanying option for it by checking the module's
documentation:</p>
<ul>
<li><a href="IndieWeb.Http.Adapter.html"><code class="inline">IndieWeb.Http.Adapter</code></a>
</li>
<li><a href="IndieWeb.Cache.Adapter.html"><code class="inline">IndieWeb.Cache.Adapter</code></a>
</li>
<li><a href="IndieWeb.Webmention.URIAdapter.html"><code class="inline">IndieWeb.Webmention.URIAdapter</code></a>
</li>
<li><a href="IndieWeb.Auth.Adapter.html"><code class="inline">IndieWeb.Auth.Adapter</code></a>
</li>
</ul>
<h3 id="module-default-adapters" class="section-heading">
<a href="#module-default-adapters" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Default Adapters
</h3>
<p>This library ships with support for <a href="https://hexdocs.pm/httpotion/3.1.1/HTTPotion.html"><code class="inline">HTTPotion</code></a> via
<a href="IndieWeb.Http.Adapters.HTTPotion.html"><code class="inline">IndieWeb.Http.Adapters.HTTPotion</code></a> and <a href="https://hexdocs.pm/cachex/3.1.3/Cachex.html"><code class="inline">Cachex</code></a> via
<a href="IndieWeb.Cache.Adapters.Cachex.html"><code class="inline">IndieWeb.Cache.Adapters.Cachex</code></a>. There's a default implementatiion for
handling authentication that allows any <code class="inline">me</code> value to be valid.</p>
<p>There's no default adapter for resolving URIs for Webmentions.</p>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.19.3),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>