update docs

ObsidiaHQ · Jan 12, 2023 · d0f1d92 · d0f1d92
1 parent c1c517c
commit d0f1d92
Show file tree

Hide file tree

Showing 15 changed files with 3,267 additions and 0 deletions.
diff --git a/doc/api/__404error.html b/doc/api/__404error.html
@@ -0,0 +1,103 @@
+<!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, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="generator" content="made with love by dartdoc 5.1.0-dev">
+  <meta name="description" content="cuid2 API docs, for the Dart programming language.">
+  <title>cuid2 - Dart API docs</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+
+  <link rel="stylesheet" href="static-assets/github.css?v1">
+  <link rel="stylesheet" href="static-assets/styles.css?v1">
+  <link rel="icon" href="static-assets/favicon.png?v1">
+
+
+</head>
+
+
+<body data-base-href=""
+      data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li><a href="https://github.com/obsidiaHQ/cuid2">cuid2 package</a></li>
+  </ol>
+  <div class="self-name">cuid2</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<main>
+
+
+  <div id="dartdoc-main-content" class="main-content">
+    <h1>404: Something's gone wrong :-(</h1>
+
+    <section class="desc">
+      <p>You've tried to visit a page that doesn't exist.  Luckily this site
+         has other <a href="index.html">pages</a>.</p>
+      <p>If you were looking for something specific, try searching:
+      <form class="search-body" role="search">
+        <input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+      </form>
+      </p>
+
+    </section>
+  </div> <!-- /.main-content -->
+
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+  <li><a href="https://github.com/obsidiaHQ/cuid2">cuid2 package</a></li>
+</ol>
+
+
+    <h5><span class="package-name">cuid2</span> <span class="package-kind">package</span></h5>
+    <ol>
+      <li class="section-title">Libraries</li>
+      <li><a href="cuid2/cuid2-library.html">cuid2</a></li>
+</ol>
+
+  </div>
+
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+
+</main>
+
+<footer>
+  <span class="no-break">
+    cuid2
+      2.0.0
+  </span>
+
+
+</footer>
+
+
+
+<script src="static-assets/highlight.pack.js?v1"></script>
+<script src="static-assets/script.js?v1"></script>
+
+
+
+</body>
+
+</html>
+
diff --git a/doc/api/categories.json b/doc/api/categories.json
@@ -0,0 +1 @@
+[]
diff --git a/doc/api/cuid2/cuid.html b/doc/api/cuid2/cuid.html
@@ -0,0 +1,131 @@
+<!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, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="description" content="API docs for the cuid function from the cuid2 library, for the Dart programming language.">
+  <title>cuid function - cuid2 library - Dart API</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+
+  <link rel="stylesheet" href="../static-assets/github.css?v1">
+  <link rel="stylesheet" href="../static-assets/styles.css?v1">
+  <link rel="icon" href="../static-assets/favicon.png?v1">
+
+
+</head>
+
+
+<body data-base-href="../"
+      data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li><a href="../index.html">cuid2</a></li>
+    <li><a href="../cuid2/cuid2-library.html">cuid2</a></li>
+    <li class="self-crumb">cuid function</li>
+  </ol>
+  <div class="self-name">cuid</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<main>
+
+
+  <div id="dartdoc-main-content" class="main-content">
+      <div>
+<h1><span class="kind-function">cuid</span> function 
+    <a href="https://dart.dev/null-safety" class="feature feature-null-safety" title="Supports the null safety language feature.">Null safety</a>
+
+</h1></div>
+
+    <section class="multi-line-signature">
+
+
+<span class="returntype"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
+<span class="name ">cuid</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="cuid-param-length">[<span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">length</span> = <span class="default-value">24</span>]</span></li>
+</ol>)
+
+    </section>
+
+<section class="desc markdown">
+  <p>Generates a new id (default length of 24).</p>
+</section>
+
+
+
+<section class="summary source-code" id="source">
+  <h2><span>Implementation</span></h2>
+  <pre class="language-dart"><code class="language-dart">String cuid([int length = 24]) =&gt; Cuid(length).gen();</code></pre>
+</section>
+
+
+  </div> <!-- /.main-content -->
+
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+  <li><a href="../index.html">cuid2</a></li>
+  <li><a href="../cuid2/cuid2-library.html">cuid2</a></li>
+  <li class="self-crumb">cuid function</li>
+</ol>
+
+
+    <h5>cuid2 library</h5>
+    <ol>
+
+
+
+
+
+  <li class="section-title"><a href="../cuid2/cuid2-library.html#functions">Functions</a></li>
+  <li><a href="../cuid2/cuid.html">cuid</a></li>
+  <li><a href="../cuid2/cuidConfig.html">cuidConfig</a></li>
+  <li><a href="../cuid2/cuidSecure.html">cuidSecure</a></li>
+
+
+
+</ol>
+
+  </div><!--/.sidebar-offcanvas-left-->
+
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div><!--/.sidebar-offcanvas-->
+
+</main>
+
+<footer>
+  <span class="no-break">
+    cuid2
+      2.0.0
+  </span>
+
+
+</footer>
+
+
+
+<script src="../static-assets/highlight.pack.js?v1"></script>
+<script src="../static-assets/script.js?v1"></script>
+
+
+
+</body>
+
+</html>
+