prepare for release

asinghvi17 · Jan 30, 2025 · 5dc60b6 · 5dc60b6 · asinghvi17 · Jan 30, 2025
1 parent 70e6553
commit 5dc60b6
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DocumenterPages"
 uuid = "3b6f6c89-491e-49ab-a70c-af796c43d097"
 authors = ["Anshul Singhvi <anshulsinghvi@gmail.com> and contributors"]
-version = "0.1.0-DEV"
+version = "0.1.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

diff --git a/src/pagenode.jl b/src/pagenode.jl
@@ -1,4 +1,29 @@
+"""
+    PageNode(input; visible, collapsed)
+    PageNode(this_page, children; visible, collapsed)
 
+Creates a `PageNode` object, which may have some children.
+
+`input` can be anything that `pages` accepts in `Documenter.makedocs`,
+for example a string, a pair of strings, a vector of strings or pairs, or any combination thereof.
+
+You can also specify details for the toplevel page and its children separately in the two-argument constructor.
+
+## Examples
+
+```julia
+PageNode("index.md")
+```
+
+```julia
+PageNode("Home" => "index.md")
+```
+
+```julia
+PageNode(["index.md", "gallery.md"])
+```
+
+"""
 struct PageNode
     # page contents
     page::Union{String, Nothing}