diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index ba446c2..d362b47 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -1,5 +1,5 @@ -title = "" -baseURL = "https://roll20.github.io/beacon-docs" +title = "The Beacon SDK by Roll20" +baseurl = "http://localhost/" canonifyURLs = false disableAliases = true disableHugoGeneratorInject = true @@ -17,7 +17,7 @@ defaultContentLanguage = "en" disableLanguages = ["de", "nl"] defaultContentLanguageInSubdir = false -copyRight = "Copyright (c) 2020-2024 Beacon SDK" +copyRight = "Copyright (c) Roll20, LLC" [build.buildStats] enable = true diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml index deb954d..e40e30b 100644 --- a/config/_default/menus/menus.en.toml +++ b/config/_default/menus/menus.en.toml @@ -1,51 +1,8 @@ -# [[docs]] -# name = "Prologue" -# weight = 10 -# identifier = "prologue" -# url = "/docs/prologue/" - -# [[docs]] -# name = "Help" -# weight = 60 -# identifier = "help" -# url = "/docs/help/" - -# [[docs]] -# name = "Lorem" -# weight = 70 -# identifier = "lorem" -# url = "/docs/lorem/" - -[[guide]] - name = "Lorem" - weight = 10 - identifier = "lorem" - url = "/guide/lorem/" - -[[tutorial]] - name = "Lorem" - weight = 10 - identifier = "lorem" - url = "/tutorial/lorem/" - [[main]] name = "Docs" url = "/docs/gettingstarted/introduction" -# url = "/docs/1.0/prologue/introduction/" weight = 10 -# [[social]] -# name = "Twitter" -# pre = '' -# url = "https://twitter.com/getdoks" -# weight = 10 -# -# [[social]] -# name = "Discord" -# pre = '' -# url = "https://github.com/Roll20/beacon-docs" -# weight = 20 - [[social]] name = "GitHub" pre = '' @@ -53,27 +10,7 @@ post = "v0.1.0" weight = 30 -# [[sidebar_docs]] -# name = "Getting Started" -# pageRef = "/docs/gettingstarted" -# weight = 10 -# -# [[sidebar_docs]] -# name = "Components" -# pageRef = "/docs/components" -# weight = 20 - -# [[sidebar_docs]] -# name = "About" -# pageRef = "/docs/about" -# weight = 30 - [[footer]] name = "Privacy Policy" url = "https://help.roll20.net/hc/en-us/articles/360037770793-Terms-of-Service-and-Privacy-Policy" weight = 10 - -# [[footer]] -# name = "Terms of Service" -# url = "/terms/" -# weight = 20 diff --git a/config/_default/menus/menus.nl.toml b/config/_default/menus/menus.nl.toml index 53aaaeb..e40e30b 100644 --- a/config/_default/menus/menus.nl.toml +++ b/config/_default/menus/menus.nl.toml @@ -1,39 +1,16 @@ -[[docs]] - name = "Prologue" - weight = 10 - identifier = "prologue" - url = "/docs/prologue/" - -[[docs]] - name = "Help" - weight = 60 - identifier = "help" - url = "/docs/help/" - [[main]] name = "Docs" - url = "/docs/prologue/introduction/" + url = "/docs/gettingstarted/introduction" weight = 10 -# [[main]] -# name = "Blog" -# url = "/blog/" -# weight = 20 - [[social]] name = "GitHub" - pre = "" - url = "https://github.com/h-enk/doks" + pre = '' + url = "https://github.com/Roll20/beacon-docs" post = "v0.1.0" - weight = 10 - -[[social]] - name = "Twitter" - pre = "" - url = "https://twitter.com/getdoks" - weight = 20 + weight = 30 -# [[footer]] -# name = "Privacy" -# url = "/privacy-policy/" -# weight = 10 +[[footer]] + name = "Privacy Policy" + url = "https://help.roll20.net/hc/en-us/articles/360037770793-Terms-of-Service-and-Privacy-Policy" + weight = 10 diff --git a/config/_default/params.toml b/config/_default/params.toml index fe045a9..a834fd7 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -6,9 +6,6 @@ images = ["cover.png"] # mainSections mainSections = ["docs"] -[social] - twitter = "getdoks" - # Doks (@hyas/doks-core) [doks] # Color mode @@ -25,7 +22,7 @@ mainSections = ["docs"] navBarButtonText = "Get started" # FlexSearch - flexSearch = false # true (default) or false + flexSearch = true # true (default) or false searchExclKinds = [] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] ) searchExclTypes = [] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"]) showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"]) diff --git a/config/production/hugo.toml b/config/production/hugo.toml index 65b0264..e647606 100644 --- a/config/production/hugo.toml +++ b/config/production/hugo.toml @@ -1,2 +1,2 @@ # Overrides for production environment -baseURL = "https://roll20.github.io/beacon-docs" +baseurl = "https://roll20.github.io/beacon-docs" diff --git a/content/blog/_index.md b/content/blog/_index.md deleted file mode 100644 index a99c1bd..0000000 --- a/content/blog/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Blog" -description: "" -summary: "" -date: 2023-09-07T16:21:44+02:00 -lastmod: 2023-09-07T16:21:44+02:00 -draft: false -weight: 50 -categories: [] -tags: [] -contributors: [] -pinned: false -homepage: false -seo: - title: "" # custom title (optional) - description: "" # custom description (recommended) - canonical: "" # custom canonical URL (optional) - noindex: false # false (default) or true ---- diff --git a/content/blog/example/index.md b/content/blog/example/index.md deleted file mode 100644 index ad2a4dd..0000000 --- a/content/blog/example/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Example Post" -description: "Just an example post." -summary: "You can use blog posts for announcing product updates and features." -date: 2023-09-07T16:27:22+02:00 -lastmod: 2023-09-07T16:27:22+02:00 -draft: false -weight: 50 -categories: [] -tags: [] -contributors: [] -pinned: false -homepage: false -seo: - title: "" # custom title (optional) - description: "" # custom description (recommended) - canonical: "" # custom canonical URL (optional) - noindex: false # false (default) or true ---- - -Well-thought-through product announcements will help increase feature awareness and engage users with new functionality. Just like [sharing your public roadmap](https://canny.io/blog/should-you-have-a-public-roadmap/), it's also a great way to let potential customers see that you're constantly improving. - -## Further reading - -- Read [How to announce product updates and features](https://canny.io/blog/announce-product-updates-features/) diff --git a/content/docs/components/InitRelay.md b/content/docs/components/InitRelay.md index 2e90bc4..49d14c6 100644 --- a/content/docs/components/InitRelay.md +++ b/content/docs/components/InitRelay.md @@ -48,13 +48,13 @@ These components are crucial for handling actions, computations, macros, and rol {{< link-card title="Actions" description=" Actions define specific operations that can be performed by characters within the Roll20 Tabletop. These operations can range from simple tasks like rolling a dice to more complex interactions such as casting spells or activating abilities." - href="/beacon-docs/docs/components/actions/" + href="/docs/components/actions/" target="_blank" >}} {{< link-card title="Handlers" description="Handlers are event listeners that manage communication between the Roll20 Tabletop and the character sheet. They respond to various events, such as changes in character attributes or settings, and trigger appropriate actions or updates." - href="/beacon-docs/docs/components/handlers/" + href="/docs/components/handlers/" target="_blank" >}} {{< /card-grid >}} @@ -63,13 +63,13 @@ These components are crucial for handling actions, computations, macros, and rol {{< link-card title="Computed" description=" Computed properties are dynamic values derived from other character attributes. They allow for the creation of complex, calculated attributes that automatically update when their dependencies change." - href="/beacon-docs/docs/components/computed/" + href="/docs/components/computed/" target="_blank" >}} {{< link-card title="Custom Sheet Macro Attributes" description="Macro attributes handle the conversion of older Custom Sheet macro attributes to the new format used in the Beacon SDK. This ensures compatibility with older character sheets and macros, allowing for a smooth transition to the new system." - href="/beacon-docs/docs/components/custom-sheet-macro-attributes/" + href="/docs/components/custom-sheet-macro-attributes/" target="_blank" >}} {{< /card-grid >}} @@ -78,14 +78,14 @@ These components are crucial for handling actions, computations, macros, and rol {{< link-card title="Rolls" description="The Rolls component allows for advanced dice-rolling mechanics within the Roll20 Tabletop. It supports both simple and complex rolls, providing flexibility in how roll results are displayed and computed." - href="/beacon-docs/docs/components/rolls/" + href="/docs/components/rolls/" target="_blank" >}} {{< link-card title="Dispatch" description="The dispatch object provides methods for sending commands from the character sheet back to the host. Except when specified every method returns a promise." - href="/beacon-docs/docs/components/dispatch/" + href="/docs/components/dispatch/" target="_blank" >}} {{< /card-grid >}} \ No newline at end of file diff --git a/content/docs/components/roll.md b/content/docs/components/roll.md index 826805d..09d7bde 100644 --- a/content/docs/components/roll.md +++ b/content/docs/components/roll.md @@ -25,7 +25,7 @@ Join to get access to the Beacon SDK, the community sheet repo for Beacon sheet, The Roll20 Tabletop and Roll20 Characters (both refered to as host throughout the rest of this page) have several new features that enhance the way rolls are handled and displayed. These features include attributes and elements that allow for dynamic roll results and interactivity within the host. [Vist the Roll20 help center to learn more about Roll20's Dice Rolling system](https://help.roll20.net/hc/en-us/articles/360037773133-Dice-Reference) -The most command way to trigger a dice roll is through the dispatch object returned from the `initRelay`, but it could also be called from [actions](/beacon-docs/docs/components/actions): +The most command way to trigger a dice roll is through the dispatch object returned from the `initRelay`, but it could also be called from [actions](/docs/components/actions): ```typescript dispatch.roll({ rolls: { [rollName: string]: string } // Ex. {attack: '1d20+4', damage: `3d6+2`} @@ -45,7 +45,7 @@ The dispatch roll method and the actions roll section do not post to the chat, i ## Posting A Roll to the Chat -The roll method does not send or post any data to the chat on it's own. We instead have to use [dispatch's post](/beacon-docs/docs/components/dispatch/#post) method to send our roll results along with any other content to the chat. +The roll method does not send or post any data to the chat on it's own. We instead have to use [dispatch's post](/docs/components/dispatch/#post) method to send our roll results along with any other content to the chat. ```typescript dispatch.post({ diff --git a/content/docs/gettingstarted/installation.md b/content/docs/gettingstarted/installation.md index 7398153..12da365 100644 --- a/content/docs/gettingstarted/installation.md +++ b/content/docs/gettingstarted/installation.md @@ -56,7 +56,7 @@ This will install the Beacon SDK package to your project's `package.json` file. The Beacon package exports various utilities you can use in your application. The main one that needs to be setup to enable the connection between Beacon SDK and Roll20 is `initRelay`. -Ideally you would want to call this when your sheet is initalizing, and it is the function where you will define sheet actions, computed values, and how the sheet will response to or send character data changes. [visit the initRelay page for a more detailed breakdown.](/beacon-docs/docs/components/initrelay/) +Ideally you would want to call this when your sheet is initalizing, and it is the function where you will define sheet actions, computed values, and how the sheet will response to or send character data changes. [visit the initRelay page for a more detailed breakdown.](/docs/components/initrelay/) Add the following to your project: ```javascript @@ -77,7 +77,7 @@ const dispatch = initRelay({ }) ``` -`initRelay` returns a dispatch function that allows you to call methods or send changes from the sheet to Roll20. Check out the page on [dispatch](/beacon-docs/docs/components/dispatch/) to learn more about the different methods. +`initRelay` returns a dispatch function that allows you to call methods or send changes from the sheet to Roll20. Check out the page on [dispatch](/docs/components/dispatch/) to learn more about the different methods. ## Step 3: Settings up the Roll20 tabletop sandbox diff --git a/hugo_stats.json b/hugo_stats.json index 90e6e67..259e3c8 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -7,6 +7,7 @@ "base", "body", "button", + "circle", "code", "details", "div", @@ -14,6 +15,8 @@ "figcaption", "figure", "footer", + "form", + "g", "h1", "h2", "h3", @@ -24,6 +27,8 @@ "html", "img", "input", + "kbd", + "label", "li", "line", "link", @@ -46,22 +51,25 @@ "table", "tbody", "td", + "template", "th", "thead", + "time", "title", "tr", "ul" ], "classes": [ "CTAbutton", + "DocSearch-Label", "active", "anchor", "bg-dots", - "blog", "blog-header", "breadcrumb", "breadcrumb-item", "btn", + "btn-close", "btn-link", "btn-primary", "callout", @@ -96,10 +104,13 @@ "container-lg", "content", "contributors", + "created-date", "d-flex", "d-inline-flex", "d-lg-block", "d-lg-none", + "d-md-block", + "d-md-none", "d-none", "d-xl-block", "d-xl-none", @@ -120,10 +131,13 @@ "flex-sm-row", "flex-xl-nowrap", "footer", + "form-control", + "form-control-lg", "frame", + "fs-5", "h-auto", - "h3", "h4", + "h5", "header", "highlight", "home", @@ -133,10 +147,10 @@ "icon-tabler-arrow-right", "icon-tabler-brand-github", "icon-tabler-chevron-up", - "icon-tabler-clock", "icon-tabler-dots-vertical", "icon-tabler-menu", "icon-tabler-moon", + "icon-tabler-search", "icon-tabler-sun", "icon-tabler-x", "is-terminal", @@ -150,17 +164,31 @@ "list-inline-item", "list-nested", "list-unstyled", + "list-view", "m-2", + "mb-0", "mb-3", "mb-4", "me-2", "me-auto", "me-lg-1", "me-lg-3", + "message", + "modal", + "modal-body", + "modal-content", + "modal-dialog", + "modal-dialog-scrollable", + "modal-footer", + "modal-fullscreen-md-down", + "modal-header", + "modal-title", "ms-2", + "ms-3", "ms-auto", "ms-lg-2", "mt-1", + "mt-3", "mt-4", "mt-n3", "mx-2", @@ -194,25 +222,34 @@ "pb-3", "pb-4", "pe-4", - "position-relative", "privacy", "ps-3", "pt-4", - "reading-time", + "px-0", + "query-no-results", "rounded-circle", "row", + "search-form", + "search-input", + "search-loading", + "search-no-recent", + "search-no-results", + "search-result", + "search-results", + "search-text", "section", "section-features", "section-md", "section-nav", "single", "social-link", + "status", "sticky-top", "stretched-link", + "submitted", "svg-inline", "tags", "taxonomy", - "text-body", "text-body-secondary", "text-center", "text-decoration-none", @@ -220,10 +257,10 @@ "text-lg-end", "text-lg-start", "text-muted", - "text-nowrap", "text-reset", "text-start", "title", + "title-submitted", "toc-mobile", "visually-hidden", "w-100", @@ -248,7 +285,6 @@ "debouncedcompendiumrequest", "dispatch", "doks-docs-nav", - "further-reading", "getactions", "getcomputed", "getting-started", @@ -286,6 +322,12 @@ "roll-buttons", "roll-template", "rolls-results-format", + "search-form", + "searchModal", + "searchModalLabel", + "searchResults", + "searchToggleDesktop", + "searchToggleMobile", "setcomputed", "setcontainersize", "socialMenu", diff --git a/layouts/index.html b/layouts/index.html index 477e6bc..3f14d2c 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -22,7 +22,7 @@

{{ .Title }}