website: re-generate commons

xpack-dev-tools · Jan 17, 2025 · 505ce7f · 505ce7f
1 parent 5d129d4
commit 505ce7f
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 20 deletions.
diff --git a/website/blog/_templates/blog-post-release-part-1-liquid.mdx b/website/blog/_templates/blog-post-release-part-1-liquid.mdx
@@ -1,10 +1,10 @@
 ---
-title: xPack {{appName}} v{{releaseVersion}} released
+title: xPack {{packageConfig.longName}} v{{releaseVersion}} released
 seo_title: Version {{releaseVersion}} released
 description: Version {{releaseVersion}} is a TODO new/maintenance release.
 keywords:
   - xpack
-  - {{appLcName}}
+  - {{packageConfig.shortName}}
   - release
 
 date: {{releaseDate}}
@@ -68,10 +68,10 @@ The binary files are available from <a href={frontMatter.download_url}>GitHub Re
 The easiest way to install this specific version, is by using **xpm**:
 
 <CodeBlock language="console"> {
-`xpm install @xpack-dev-tools/{{appLcName}}@${frontMatter.version}.${frontMatter.npm_subversion} -verbose
+`xpm install @xpack-dev-tools/{{packageConfig.shortName}}@${frontMatter.version}.${frontMatter.npm_subversion} -verbose
 `} </CodeBlock>
 
-Comprehensive instructions for installing **xPack {{appName}}** on different platforms
+Comprehensive instructions for installing **xPack {{packageConfig.longName}}** on different platforms
 can be found in the [Install Guide](/docs/install/).
 
 ## Compliance

diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx
@@ -255,7 +255,7 @@ To contribute Pull Requests, fork the project and be sure the **Copy the master
 Use the `xpack-development` branch and be sure you contribute the
 Pull Requests back to the `xpack-development` branch.
 
-::
+:::
 
 <details>
 <summary>Get the writable helper sources (optional, for development purposes)</summary>

diff --git a/website/docs/install/_automatic-install-quick-test.mdx b/website/docs/install/_automatic-install-quick-test.mdx
@@ -6,8 +6,8 @@ import AutomaticInstallQuickTest from './_common/_automatic-install-quick-test.m
 {/* ------------------------------------------------------------------------ */}
 
 <AutomaticInstallQuickTest
-  appName="GNU Bash"
-  appLcName="bash"
+  longName="GNU Bash"
+  shortName="bash"
   programName="bash"
   branding="GNU bash, version "
 />
diff --git a/website/docs/install/_common/_automatic-install-quick-test.mdx b/website/docs/install/_common/_automatic-install-quick-test.mdx
@@ -11,14 +11,14 @@ import customField from '@site/src/libs/customField';
 
 ### Quick test
 
-To check if the {props.appName} installed by **xpm** starts properly, use something like:
+To check if the {props.longName} installed by **xpm** starts properly, use something like:
 
 <Tabs groupId="operating-systems">
 
 <TabItem value="windows" label="Windows" default>
 
 <CodeBlock language="console"> {
-`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\${props.appLcName}\\${customField('xpackVersion')}.${customField('npmSubversion')}\\.content\\bin\\${props.programName}.exe --version
+`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\${props.shortName}\\${customField('xpackVersion')}.${customField('npmSubversion')}\\.content\\bin\\${props.programName}.exe --version
 ${props.branding}${customField('upstreamVersion')}
 `} </CodeBlock>
 
@@ -27,7 +27,7 @@ ${props.branding}${customField('upstreamVersion')}
 <TabItem value="macos" label="macOS">
 
 <CodeBlock language="console"> {
-`% ~/Library/xPacks/@xpack-dev-tools/${props.appLcName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
+`% ~/Library/xPacks/@xpack-dev-tools/${props.shortName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
 ${props.branding}${customField('upstreamVersion')}
 `} </CodeBlock>
 
@@ -36,7 +36,7 @@ ${props.branding}${customField('upstreamVersion')}
 <TabItem value="linux" label="GNU/Linux">
 
 <CodeBlock language="console"> {
-`$ ~/.local/xPacks/@xpack-dev-tools/${props.appLcName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
+`$ ~/.local/xPacks/@xpack-dev-tools/${props.shortName}/${customField('xpackVersion')}.${customField('npmSubversion')}/.content/bin/${props.programName} --version
 ${props.branding}${customField('upstreamVersion')}
 `} </CodeBlock>
 

diff --git a/website/docs/install/_common/_manual-install-quick-test.mdx b/website/docs/install/_common/_manual-install-quick-test.mdx
@@ -11,14 +11,14 @@ import customField from '@site/src/libs/customField';
 
 ### Quick test {#manual-install-quick-test}
 
-To check if the {props.appName} installed manually starts properly, use something like:
+To check if the {props.longName} installed manually starts properly, use something like:
 
 <Tabs groupId="operating-systems">
 
 <TabItem value="windows" label="Windows" default>
 
 <CodeBlock language="console"> {
-`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\${props.appLcName}\\xpack-${props.appLcName}-${customField('xpackVersion')}\\bin\\${props.programName}.exe --version
+`C:\\> %USERPROFILE%\\AppData\\Roaming\\xPacks\\${props.shortName}\\xpack-${props.shortName}-${customField('xpackVersion')}\\bin\\${props.programName}.exe --version
 ${props.branding}${customField('upstreamVersion')}
 `} </CodeBlock>
 
@@ -27,7 +27,7 @@ ${props.branding}${customField('upstreamVersion')}
 <TabItem value="macos" label="macOS">
 
 <CodeBlock language="console"> {
-`% ~/Library/xPacks/${props.appLcName}/xpack-${props.appLcName}-${customField('xpackVersion')}/bin/${props.programName} --version
+`% ~/Library/xPacks/${props.shortName}/xpack-${props.shortName}-${customField('xpackVersion')}/bin/${props.programName} --version
 ${props.branding}${customField('upstreamVersion')}
 `} </CodeBlock>
 
@@ -36,7 +36,7 @@ ${props.branding}${customField('upstreamVersion')}
 <TabItem value="linux" label="GNU/Linux">
 
 <CodeBlock language="console"> {
-`$ ~/.local/xPacks/${props.appLcName}/xpack-${props.appLcName}-${customField('xpackVersion')}/bin/${props.programName} --version
+`$ ~/.local/xPacks/${props.shortName}/xpack-${props.shortName}-${customField('xpackVersion')}/bin/${props.programName} --version
 ${props.branding}${customField('upstreamVersion')}
 `} </CodeBlock>
 

diff --git a/website/docs/install/_manual-install-quick-test.mdx b/website/docs/install/_manual-install-quick-test.mdx
@@ -6,8 +6,8 @@ import ManualInstallQuickTest from './_common/_manual-install-quick-test.mdx'
 {/* ------------------------------------------------------------------------ */}
 
 <ManualInstallQuickTest
-  appName="GNU Bash"
-  appLcName="bash"
+  longName="GNU Bash"
+  shortName="bash"
   programName="bash"
   branding="GNU bash, version "
 />
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -67,8 +67,6 @@ function getCustomFields() {
   }
 
   return {
-    appName: rootPackageJson.xpack.properties.appName,
-    appLcName: rootPackageJson.xpack.properties.appLcName,
     version: jsonVersion,
     xpackVersion,
     xpackSemver,

diff --git a/website/src/components/ReleasesList/index.tsx b/website/src/components/ReleasesList/index.tsx
@@ -26,7 +26,7 @@ export function ReleasesList({items}): JSX.Element {
         pluginData.releasesTable.length > 0 ?
           pluginData.releasesTable.map(release => (
             <li>
-              <a href={release.permalink}>{release.title}</a> {release.downloadUrl === "true" ? (<>(<a href={release.downloadUrl}>download</a>)</>) : (<></>)}
+              <a href={release.permalink}>{release.title}</a> {release.downloadUrl ? (<>(<a href={release.downloadUrl}>download</a>)</>) : (<></>)}
             </li>
           )) :
           (