Add documentations (#1)

.github/workflows/ci-cd.yml

@@ -74,3 +74,38 @@ jobs:
           distribution: ${{ env.JDK_DISTRIBUTION }}
       - name: Run unit & integration tests
         run: mvn -B clean verify
+
+  deploy-docs:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ env.JDK_VERSION }}
+          distribution: ${{ env.JDK_DISTRIBUTION }}
+      - name: Install Dependencies
+        working-directory: docs
+        run: yarn
+      - name: Build Documentation
+        working-directory: docs
+        run: yarn build
+      - name: Generate Javadoc
+        run: mvn -B clean javadoc:javadoc
+      - name: Move Javadoc into documentation directory
+        if: github.ref == 'refs/heads/master'
+        run: mv target/site/apidocs/ docs/build/apidocs/
+      - name: Load CNAME file
+        if: github.ref == 'refs/heads/master'
+        run: cp docs/CNAME docs/build
+      - name: Deploy Documentation (including Javadoc) to GitHub Pages
+        if: github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build
+          enable_jekyll: false
+          user_name: ${{ env.USER }}
+          user_email: ${{ env.EMAIL }}

docs/.gitignore

@@ -0,0 +1,42 @@
+# Copyright 2024 Paion Data
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

docs/CNAME

@@ -0,0 +1 @@
+aristotle-ws.com

docs/README.md

@@ -0,0 +1,49 @@
+Aristotle Documentation
+=======================
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+Installation
+------------
+
+```console
+yarn
+```
+
+Local Development
+-----------------
+
+```console
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without
+having to restart the server.
+
+Build
+-----
+
+```console
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting
+service.
+
+Deployment
+----------
+
+Using SSH:
+
+```console
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```console
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the
+`gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2024 Paion Data
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/intro.mdx

@@ -0,0 +1,20 @@
+---
+sidebar_position: 1
+title: Introduction
+---
+
+[//]: # (Copyright 2024 Paion Data)
+
+[//]: # (Licensed under the Apache License, Version 2.0 (the "License");)
+[//]: # (you may not use this file except in compliance with the License.)
+[//]: # (You may obtain a copy of the License at)
+
+[//]: # (    http://www.apache.org/licenses/LICENSE-2.0)
+
+[//]: # (Unless required by applicable law or agreed to in writing, software)
+[//]: # (distributed under the License is distributed on an "AS IS" BASIS,)
+[//]: # (WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.)
+[//]: # (See the License for the specific language governing permissions and)
+[//]: # (limitations under the License.)
+
+Coming soon.

docs/docusaurus.config.ts

@@ -0,0 +1,121 @@
+/**
+ * Copyright 2024 Paion Data
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+const config: Config = {
+  title: 'Aristotle',
+  tagline: 'Webservice with first-class support for Graph Database',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://aristotle-ws.com',
+  baseUrl: '/',
+
+  organizationName: 'paion-data',
+  projectName: 'aristotle',
+
+  onBrokenLinks: 'warn',
+  onBrokenMarkdownLinks: 'warn',
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          sidebarPath: './sidebars.ts',
+          editUrl:
+              'https://github.com/paion-data/aristotle/tree/master/docs',
+        },
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    // Replace with your project's social card
+    image: 'img/docusaurus-social-card.jpg',
+    navbar: {
+      title: 'Aristotle',
+      logo: {
+        alt: 'Aristotle Logo',
+        src: 'img/logo.svg',
+      },
+      items: [
+        {
+          type: "localeDropdown",
+          position: "left",
+        },
+        {
+          type: 'docSidebar',
+          sidebarId: 'tutorialSidebar',
+          position: 'left',
+          label: 'Documentation',
+        },
+        {
+          href: "https://aristotle-ws.com/apidocs",
+          label: "API",
+          position: "left",
+        },
+        {
+          href: 'https://github.com/paion-data/aristotle',
+          label: ' ',
+          position: 'right',
+          className: 'header-icon-link header-github-link',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Docs',
+          items: [
+            {
+              label: 'Documentation',
+              to: '/docs/intro',
+            },
+          ],
+        },
+        {
+          title: 'More',
+          items: [
+            {
+              label: 'GitHub',
+              href: 'https://github.com/paion-data/aristotle',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} Paion Data. Built with Docusaurus.`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+      additionalLanguages: ["java", "bash", "json"]
+    },
+    algolia: {
+        appId: 'DXTOFNB5C6',
+        apiKey: 'eca40f6bc63a92b106660dadd97f8703',
+        indexName: 'aristotle_ws'
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;