build(deps): harden docs site dependencies

.github/workflows/build-and-publish.yml

@@ -16,14 +16,14 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [20.x]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
@@ -52,7 +52,7 @@ jobs:
         with:
           args: --acl public-read --follow-symlinks --delete
         env:
-          SOURCE_DIR: 'website/build/techdocs'
+          SOURCE_DIR: 'website/build'
 
       - name: Invalidate Cloudfront
         uses: chetan/invalidate-cloudfront-action@master

.gitignore

@@ -6,6 +6,7 @@ lib/core/metadata.js
 lib/core/MetadataBlog.js
 
 website/translated_docs
+website/.docusaurus/
 website/build/
 website/yarn.lock
 website/node_modules

docs/accordproject-template.md

@@ -130,7 +130,7 @@ The combination of text and model already makes templates _machine-readable_, wh
 
 ### During Drafting
 
-In the [Overview](accordproject.md) Section, we already saw how logic can be embedded in the text of the template itself to automatically calculate a monthly payment for a [fixed rate loan]():
+In the [Overview](accordproject.md) Section, we already saw how logic can be embedded in the text of the template itself to automatically calculate a monthly payment for a fixed rate loan:
 
 ```tem
 ## Fixed rate loan
@@ -210,4 +210,3 @@ Build your first smart legal contract templates, either [online](tutorial-studio
 Explore [sample templates](started-resources.md) and other resources in the rest of this documentation.
 
 If some of technical words are unfamiliar, please consult the [Glossary](ref-glossary.md) for more detailed explanations.
-

docs/ergo-tutorial.md

@@ -1,6 +1,6 @@
 ---
 id: ergo-tutorial
-title: Ergo: A Tutorial
+title: "Ergo: A Tutorial"
 ---
 
 ## Overview of Accord

docs/started-hello.md

@@ -11,13 +11,13 @@ You can download a single clause or contract template from the [Accord Project T
 
 If you click on the Template Library link, you should see a Web Page which looks as follows:
 
-![Basic-Use-1](/docs/assets/basic/use1.png)
+![Basic-Use-1](./assets/basic/use1.png)
 
 Scrolling down that page, you can see the index for the open-source templates along with their version, and whether they are a Clause or Contract template.
 
 Click on the link to the `helloworld` template. You should be taken to a page which looks as follows:
 
-![Basic-Use-2](/docs/assets/basic/use2.png)
+![Basic-Use-2](./assets/basic/use2.png)
 
 Then click on the `Download Archive` button under the description for the template (highlighted in the red box in the figure). This should download the latest template archive for the `helloworld` template.
 
@@ -208,7 +208,7 @@ Then run `cicero trigger --template helloworld@0.14.0.cta --sample sample.md --r
 
 Feel free to try the same commands to parse and execute other templates from the Accord Project Library. Note that for each template, you can find samples for the text, for the request and for the state on the corresponding Web page. For instance, a sample for the [Late Delivery And Penalty](https://templates.accordproject.org/latedeliveryandpenalty@0.15.0.html) clause is in the red box in the following image:
 
-![Basic-Use-3](/docs/assets/basic/use3.png)
+![Basic-Use-3](./assets/basic/use3.png)
 
 ### More About Cicero
 
@@ -217,4 +217,3 @@ You can find more information on how to create or publish Accord Project templat
 ### Run on Different Platforms
 
 Templates may be executed on different platforms, not only from the command line. You can find more information on how to execute Accord Project templates on different platforms (Node.js, Hyperledger Fabric, etc.) in the [Template Execution](tutorial-nodejs) tutorials.
-

docs/tutorial-library.md

@@ -29,7 +29,7 @@ git clone https://github.com/accordproject/cicero-template-library
 
 Alternatively, you can download the library directly by visiting the [GitHub Repository for the Template Library](https://github.com/accordproject/cicero-template-library) and use the "Download" button as shown on this snapshot:
 
-![Basic-Library-1](/docs/assets/basic/library1.png)
+![Basic-Library-1](./assets/basic/library1.png)
 
 ### Install the Library
 
@@ -166,4 +166,3 @@ You should see a response as follows:
 To contribute a change to the Accord Project library, please [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the repository and then create a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
 
 Note that templates should have unit tests. See any of the `./test` directories in the templates contained in the template library for an examples with unit tests, or consult the [Testing Reference](ref-testing) Section of this documentation.
-

website/docusaurus.config.js

@@ -0,0 +1,120 @@
+// @ts-check
+
+const {themes: prismThemes} = require('prism-react-renderer');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Accord Project',
+  tagline: 'Open Source Documentation',
+  url: 'https://docs.accordproject.org',
+  baseUrl: '/',
+  favicon: 'img/favicon.png',
+  organizationName: 'accordproject',
+  projectName: 'techdocs',
+  onBrokenLinks: 'ignore',
+  onBrokenAnchors: 'ignore',
+  markdown: {
+    format: 'detect',
+    hooks: {
+      onBrokenMarkdownLinks: 'ignore',
+      onBrokenMarkdownImages: 'ignore',
+    },
+  },
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          path: '../docs',
+          sidebarPath: require.resolve('./sidebars.js'),
+          disableVersioning: true,
+          editUrl: 'https://github.com/accordproject/techdocs/edit/main/',
+        },
+        blog: {
+          showReadingTime: true,
+          onInlineAuthors: 'ignore',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      }),
+    ],
+  ],
+  scripts: [
+    'https://buttons.github.io/buttons.js',
+    'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+    '/js/code-block-buttons.js',
+  ],
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      image: 'img/docusaurus.png',
+      navbar: {
+        title: 'Accord Project',
+        logo: {
+          alt: 'Accord Project',
+          src: 'img/A-MARK-ACCORDPROJECT-ONELINE-white.svg',
+        },
+        items: [
+          {
+            type: 'docSidebar',
+            sidebarId: 'docs',
+            position: 'left',
+            label: 'Documentation',
+          },
+          {
+            href: 'https://studio.accordproject.org',
+            label: 'Try Online!',
+            position: 'left',
+          },
+          {
+            href: 'https://github.com/accordproject',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {label: 'Overview', to: '/docs/accordproject'},
+              {label: 'Getting Started', to: '/docs/started-installation'},
+              {label: 'Template Guides', to: '/docs/markup-ciceromark'},
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {label: 'Stack Overflow', href: 'http://stackoverflow.com/questions/tagged/cicero'},
+              {label: 'Discord', href: 'https://discord.com/invite/Zm99SKhhtA'},
+              {label: 'Twitter', href: 'https://twitter.com/accordhq'},
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {label: 'Blog', href: 'https://medium.com/@accordhq'},
+              {label: 'GitHub', href: 'https://github.com/accordproject'},
+            ],
+          },
+        ],
+        copyright: `Copyright © 2018-${new Date().getFullYear()} Accord Project, LLC.`,
+      },
+      prism: {
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
+        additionalLanguages: ['typescript', 'json'],
+      },
+      algolia: {
+        appId: 'BH4D9OD16A',
+        apiKey: '1679802ddfc315329d6b5f4616b30e51',
+        indexName: 'accordproject_api',
+      },
+    }),
+};
+
+module.exports = config;