chore: docs

ragrag · Jul 26, 2024 · 92f1ad8 · 92f1ad8
1 parent b072261
commit 92f1ad8
Show file tree

Hide file tree

Showing 29 changed files with 1,676 additions and 821 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,8 @@ Art by [KyasarinHagaren](docs/https://www.reddit.com/user/KyasarinHagaren)
 
 **mayonaka** _(ma-yo-na-ka)_ is a flexible folder builder for javascript runtimes. It provides a very minimal yet fluent builder interface on top of the familiar node:fs API with concurrency control
 
+## API Reference: [https://ragrag.github.io/mayonaka](https://ragrag.github.io/mayonaka)
+
 ## Example
 
 Creating a similar directory with mayonaka
@@ -59,19 +61,3 @@ function* iterable() {
   }
 }
 ```
-
-## API Reference
-
-### Classes
-
-- [Mayonaka](docs/Class.Mayonaka.md)
-- [MayonakaFolder](docs/Class.MayonakaFolder.md)
-- [MayonakaSync](docs/Class.MayonakaSync.md)
-- [MayonakaSyncfolder](docs/Class.MayonakaSyncfolder.md)
-
-### Type Aliases
-
-- [FileData](docs/TypeAlias.FileData.md)
-- [MayonakaOptions](docs/TypeAlias.MayonakaOptions.md)
-- [MayonakaSyncOptions](docs/TypeAlias.MayonakaSyncOptions.md)
-- [SyncFileData](docs/TypeAlias.SyncFileData.md)
diff --git a/docs/.nojekyll b/docs/.nojekyll
@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
diff --git a/docs/Class.Mayonaka.md b/docs/Class.Mayonaka.md
diff --git a/docs/Class.MayonakaFolder.md b/docs/Class.MayonakaFolder.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.