Merge pull request #42 from Roll20/fix/mobile-menus-not-working

Fix mobile nav menu
Roll20 · Jul 2, 2024 · 954afc1 · 954afc1
2 parents 860de2b + d9a544e
commit 954afc1
Show file tree

Hide file tree

Showing 12 changed files with 74 additions and 165 deletions.
diff --git 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
@@ -1,79 +1,16 @@
-# [[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 = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-x" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M4 4l11.733 16h4.267l-11.733 -16z"></path><path d="M4 20l6.768 -6.768m2.46 -2.46l6.772 -6.772"></path></svg>'
-#   url = "https://twitter.com/getdoks"
-#   weight = 10
-# 
-# [[social]]
-#   name = "Discord"
-#   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-discord" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M8 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M14 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M8.5 17c0 1 -1.356 3 -1.832 3c-1.429 0 -2.698 -1.667 -3.333 -3c-.635 -1.667 -.476 -5.833 1.428 -11.5c1.388 -1.015 2.782 -1.34 4.237 -1.5l.975 1.923a11.913 11.913 0 0 1 4.053 0l.972 -1.923c1.5 .16 3.043 .485 4.5 1.5c2 5.667 2.167 9.833 1.5 11.5c-.667 1.333 -2 3 -3.5 3c-.5 0 -2 -2 -2 -3"></path><path d="M7 16.5c3.5 1 6.5 1 10 0"></path></svg>'
-#   url = "https://github.com/Roll20/beacon-docs"
-#   weight = 20
-
 [[social]]
   name = "GitHub"
   pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
   url = "https://github.com/Roll20/beacon-docs"
   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
@@ -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 = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>"
-  url = "https://github.com/h-enk/doks"
+  pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
+  url = "https://github.com/Roll20/beacon-docs"
   post = "v0.1.0"
-  weight = 10
-
-[[social]]
-  name = "Twitter"
-  pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
-  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
@@ -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
@@ -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
diff --git a/content/blog/example/index.md b/content/blog/example/index.md
diff --git 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 >}}
diff --git 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
@@ -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