Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kristoff-it committed Oct 25, 2024
1 parent 0be4403 commit 4797b43
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions src/context/Page.zig
Original file line number Diff line number Diff line change
Expand Up @@ -713,10 +713,18 @@ pub const Builtins = struct {
pub const linkRef = struct {
pub const signature: Signature = .{ .ret = .String };
pub const description =
\\Returns the URL of the target page.
\\Returns the URL of the target page, allowing you
\\to specify a fragment id to deep-link to a specific
\\element of the content page.
\\
\\The id will be checked by Zine and an error will be
\\reported if it does not exist.
\\
\\See the SuperMD reference documentation to learn how to give
\\ids to elements.
;
pub const examples =
\\$page.link()
\\$page.linkRef('foo')
;
pub fn call(
p: *const Page,
Expand Down

0 comments on commit 4797b43

Please sign in to comment.