add "edit page on github" button for dev docs

Author: Nick-Mazuk

cli/dist/prebuild.mjs

@@ -38,7 +38,7 @@ const getDocsData = (allFiles) => {
     const href = createUrlFromFilePath(fullPath);
     const text = createNameFromFilePath(fullPath);
     const folderName = getFolderFromPath(fullPath);
-    const output = {text, href};
+    const output = { text, href };
     if (typeof folders[folderName] === "undefined") {
       folders[folderName] = output;
     } else {
@@ -59,7 +59,7 @@ const creatTableOfContents = (pages) => {
   fs.writeFileSync(TOC_OUTPUT_PATH, contents);
 };
 const removePreviousDocs = () => {
-  fs.rmdirSync(DOCS_PUBLISH_PATH, {recursive: true});
+  fs.rmdirSync(DOCS_PUBLISH_PATH, { recursive: true });
 };
 const copyDocsFiles = (files) => {
   const docsTemplateContents = fs.readFileSync(DOCS_TEMPLATE_PATH).toString();

cli/src/templates/docs-layout.svelte

@@ -1,15 +1,37 @@
 <script lang="ts">
     import { page } from '$app/stores'
     import TableOfContents from '@nick-mazuk/ui-svelte/src/components/table-of-contents/table-of-contents.svelte'
+    import Button from '@nick-mazuk/ui-svelte/src/elements/button/button.svelte'
+    import Github from '@nick-mazuk/ui-svelte/src/elements/icon/github.svelte'
+    import Spacer from '@nick-mazuk/ui-svelte/src/utilities/spacer/spacer.svelte'
 
     import { libraryPages } from '../../lib/lib/library-pages'
+
+    const githubPrefix = 'https://github.com/Nick-Mazuk/jw-lua-scripts/blob/master/'
+    let githubUrl = ''
+    $: {
+        const path = $page.path.replace('/docs/', '')
+        if (path.startsWith('library/'))
+            githubUrl = githubPrefix + 'src/' + path.replace(/-/gu, '_') + '.lua'
+        else githubUrl = githubPrefix + 'docs/' + path + '.md'
+    }
 </script>
 
 <div class="flex md:space-x-12 wrapper my-16 w-full">
     <aside class="hidden md:block w-40 lg:w-64 flex-none pt-1">
         <TableOfContents currentItem="{$page.path}" items="{libraryPages}" size="large" />
     </aside>
-    <div class="prose max-w-full mx-auto">
-        <slot />
+    <div>
+        <div class="prose max-w-full mx-auto">
+            <slot />
+        </div>
+        {#if githubUrl}
+            <Spacer />
+            <div class="flex justify-end">
+                <Button variant="secondary" prefix="{Github}" href="{githubUrl}"
+                    >Edit page on GitHub</Button
+                >
+            </div>
+        {/if}
     </div>
 </div>

src/lib/lib/library-pages.ts

@@ -1,26 +1 @@
-import type { TocItems } from '@nick-mazuk/ui-svelte/src/components/table-of-contents'
-
-export const libraryPages: TocItems = [
-    {
-        text: 'Getting Started',
-        href: '/docs/getting-started',
-        children: [
-            { text: 'Adding Scripts', href: '/docs/getting-started/adding-scripts' },
-            { text: 'Resources', href: '/docs/getting-started/resources' },
-            { text: 'Style Guide', href: '/docs/getting-started/style-guide' },
-        ],
-    },
-    {
-        text: 'Library',
-        href: '/docs/library',
-        children: [
-            { text: 'Articulation', href: '/docs/library/articulation' },
-            { text: 'Configuration', href: '/docs/library/configuration' },
-            { text: 'Enigma String', href: '/docs/library/enigma-string' },
-            { text: 'Expression', href: '/docs/library/expression' },
-            { text: 'General Library', href: '/docs/library/general-library' },
-            { text: 'Note Entry', href: '/docs/library/note-entry' },
-            { text: 'Transposition', href: '/docs/library/transposition' },
-        ],
-    },
-]
+export const libraryPages: any[] = [{"text":"Getting Started","href":"/docs/getting-started","children":[{"text":"Adding Scripts","href":"/docs/getting-started/adding-scripts"},{"text":"Resources","href":"/docs/getting-started/resources"},{"text":"Style Guide","href":"/docs/getting-started/style-guide"}]},{"text":"Library","href":"/docs/library","children":[{"text":"Articulation","href":"/docs/library/articulation"},{"text":"Configuration","href":"/docs/library/configuration"},{"text":"Enigma String","href":"/docs/library/enigma-string"},{"text":"Expression","href":"/docs/library/expression"},{"text":"General Library","href":"/docs/library/general-library"},{"text":"Note Entry","href":"/docs/library/note-entry"},{"text":"Transposition","href":"/docs/library/transposition"}]}]

src/routes/docs/__layout.svelte

@@ -1,16 +1,37 @@
 <script lang="ts">
     import { page } from '$app/stores'
     import TableOfContents from '@nick-mazuk/ui-svelte/src/components/table-of-contents/table-of-contents.svelte'
+    import Button from '@nick-mazuk/ui-svelte/src/elements/button/button.svelte'
+    import Github from '@nick-mazuk/ui-svelte/src/elements/icon/github.svelte'
+    import Spacer from '@nick-mazuk/ui-svelte/src/utilities/spacer/spacer.svelte'
 
     import { libraryPages } from '../../lib/lib/library-pages'
 
+    const githubPrefix = 'https://github.com/Nick-Mazuk/jw-lua-scripts/blob/master/'
+    let githubUrl = ''
+    $: {
+        const path = $page.path.replace('/docs/', '')
+        if (path.startsWith('library/'))
+            githubUrl = githubPrefix + 'src/' + path.replace(/-/gu, '_') + '.lua'
+        else githubUrl = githubPrefix + 'docs/' + path + '.md'
+    }
 </script>
 
 <div class="flex md:space-x-12 wrapper my-16 w-full">
     <aside class="hidden md:block w-40 lg:w-64 flex-none pt-1">
         <TableOfContents currentItem="{$page.path}" items="{libraryPages}" size="large" />
     </aside>
-    <div class="prose max-w-full mx-auto">
-        <slot />
+    <div>
+        <div class="prose max-w-full mx-auto">
+            <slot />
+        </div>
+        {#if githubUrl}
+            <Spacer />
+            <div class="flex justify-end">
+                <Button variant="secondary" prefix="{Github}" href="{githubUrl}"
+                    >Edit page on GitHub</Button
+                >
+            </div>
+        {/if}
     </div>
 </div>

src/routes/docs/getting-started.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/getting-started/adding-scripts.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/getting-started/resources.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/getting-started/style-guide.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 
@@ -27,7 +25,7 @@ any questions at all.
 
 First off, and very importantly, I am a music composition major working as an engraver who’s only formal training in programming was three computer science courses in Python at Rice University via Coursera. Everything else has been learned through dissecting existing code and spending too many hours on stackoverflow.com. This document is intended to provide consistency in public JW Lua script development, it is not a reflection of best practices in the language of lua or a way to learn them. I am still learning, and will continue to learn.
 
-Secondly, pobody’s nerfect and I am constantly refactoring my own code to make it consistent with the syntax explained in this document. This is a living document and will be changed and updated as we go. I am malleable on the stances taken here, however, I will always weigh the cost of refactoring time. What started off as an interest in saving time and a fun little project between Robert Puff and myself has grown quite a bit with interest in JW Lua. Though the bottom line is if your code works, your code works, however folks who write code generally do like consistency and these will be some explicit instructions for consistency sake when committing your code to the public JW Lua Git Repository set up by Nick Mazuk.
+Secondly, nobody’s perfect and I am constantly refactoring my own code to make it consistent with the syntax explained in this document. This is a living document and will be changed and updated as we go. I am malleable on the stances taken here, however, I will always weigh the cost of refactoring time. What started off as an interest in saving time and a fun little project between Robert Puff and myself has grown quite a bit with interest in JW Lua. Though the bottom line is if your code works, your code works, however folks who write code generally do like consistency and these will be some explicit instructions for consistency sake when committing your code to the public JW Lua Git Repository set up by Nick Mazuk.
 
 Thirdly, for what it’s worth, I’m writing all of the code in Visual Studio Code with this Lua extension. I am using the Code Blocks chrome extension for this document with “gruvbox-dark” as the theme.
 

src/routes/docs/library.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/library/articulation.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/library/configuration.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/library/enigma-string.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/library/expression.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/library/general-library.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 
@@ -13,9 +11,12 @@
 - [get_top_left_visible_cell](#get_top_left_visible_cell)
 - [get_top_left_selected_or_visible_cell](#get_top_left_selected_or_visible_cell)
 - [is_default_measure_number_visible_on_cell](#is_default_measure_number_visible_on_cell)
+- [is_default_number_visible_and_left_aligned](#is_default_number_visible_and_left_aligned)
 - [update_layout](#update_layout)
 - [get_current_part](#get_current_part)
 - [get_page_format_prefs](#get_page_format_prefs)
+- [get_smufl_metadata_file](#get_smufl_metadata_file)
+- [is_font_smufl_font](#is_font_smufl_font)
 
 ## group_overlaps_region
 
@@ -141,6 +142,26 @@ Returns true if measure numbers for the input region are visible on the input ce
 | --- | --- |
 | \`boolean\` |  |
 
+## is_default_number_visible_and_left_aligned
+
+\`\`\`lua
+library.is_default_number_visible_and_left_aligned (meas_num_region, cell, system, current_is_part, is_for_multimeasure_rest)
+\`\`\`
+
+Returns true if measure number for the input cell is visible and left-aligned.
+
+| Input | Type | Description |
+| --- | --- | --- |
+| \`meas_num_region\` | \`FCMeasureNumberRegion\` |  |
+| \`cell\` | \`FCCell\` |  |
+| \`system\` | \`FCStaffSystem\` |  |
+| \`current_is_part\` | \`boolean\` | true if the current view is a linked part, otherwise false |
+| \`is_for_multimeasure_rest\` | \`boolean\` | true if the current cell starts a multimeasure rest |
+
+| Output type | Description |
+| --- | --- |
+| \`boolean\` |  |
+
 ## update_layout
 
 \`\`\`lua
@@ -176,7 +197,35 @@ Returns the default page format prefs for score or parts based on which is curre
 
 | Output type | Description |
 | --- | --- |
-| \`FCPageFormatPrefs\` |  |`
+| \`FCPageFormatPrefs\` |  |
+
+## get_smufl_metadata_file
+
+\`\`\`lua
+library.get_smufl_metadata_file(font_info)
+\`\`\`
+
+| Input | Type | Description |
+| --- | --- | --- |
+| \`font_info\` (optional) | \`FCFontInfo\` | if non-nil, the font to search for; if nil, search for the Default Music Font |
+
+| Output type | Description |
+| --- | --- |
+| \`file handle\|nil\` |  |
+
+## is_font_smufl_font
+
+\`\`\`lua
+library.is_font_smufl_font(font_info)
+\`\`\`
+
+| Input | Type | Description |
+| --- | --- | --- |
+| \`font_info\` (optional) | \`FCFontInfo\` | if non-nil, the font to check; if nil, check the Default Music Font |
+
+| Output type | Description |
+| --- | --- |
+| \`boolean\` |  |`
 </script>
 
 <Markdown content="{content}" headerIds />

src/routes/docs/library/note-entry.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'
 

src/routes/docs/library/transposition.svelte

@@ -1,5 +1,3 @@
-
-
 <script lang="ts">
     import Markdown from '@nick-mazuk/ui-svelte/src/typography/markdown/markdown.svelte'