Merge pull request #4 from Ocelot-Social-Community/new-website

refactor(other): new vuepress2-based website

.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+
+- package-ecosystem: "github-actions"
+  directory: "/"
+  rebase-strategy: "disabled"
+  schedule:
+    interval: weekly
+    day: "saturday"
+    timezone: "Europe/Berlin"
+    time: "03:00"
+
+- package-ecosystem: npm
+  directory: "/"
+  rebase-strategy: "disabled"
+  schedule:
+    interval: weekly
+    day: "saturday"
+    timezone: "Europe/Berlin"
+    time: "03:00"

.github/workflows/lint_pr.yml

@@ -1,7 +1,6 @@
 name: "lint pull request CI"
 
 on:
-  #pull_request:
   pull_request_target:
     types:
       - opened
@@ -12,6 +11,7 @@ jobs:
   main:
     name: Validate PR title
     runs-on: ubuntu-latest
+    if: ${{ github.actor != 'dependabot[bot]' }}
     steps:
       - uses: amannn/action-semantic-pull-request@v5
         env:

.github/workflows/test-build.yml

@@ -8,15 +8,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup Node 19
-        uses: actions/setup-node@v3
+      - name: Setup Node 20
+        uses: actions/setup-node@v4
         with:
-          node-version: '19'
+          node-version: '20'
 
       - name: npm-install
         run: npm install
 
       - name: npm-build
-        run: npm run build
+        run: npm run build

.github/workflows/test-lint.yml

@@ -8,15 +8,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup Node 19
-        uses: actions/setup-node@v3
+      - name: Setup Node 20
+        uses: actions/setup-node@v4
         with:
-          node-version: '19'
+          node-version: '20'
 
       - name: npm-install
         run: npm install
 
       - name: npm-test
-        run: npm test
+        run: npm test

.github/workflows/vuepress-deploy.yml

@@ -12,10 +12,10 @@ jobs:
     - name: Checkout
       uses: actions/checkout@master
 
-    - name: Setup Node 19
-      uses: actions/setup-node@v3
+    - name: Setup Node 20
+      uses: actions/setup-node@v4
       with:
-        node-version: 19
+        node-version: 20
 
     - name: vuepress-deploy
       uses: jenkey2011/vuepress-deploy@master
@@ -25,4 +25,4 @@ jobs:
         TARGET_BRANCH: gh-pages
         BUILD_SCRIPT: npm install && npm run build-legacy
         BUILD_DIR: docs/.vuepress/dist
-        CNAME: https://www.ocelot.social
+        CNAME: https://www.ocelot.social

.gitignore

@@ -1,2 +1,6 @@
+.DS_Store
 /node_modules/
 /docs/.vuepress/dist/
+/docs/.vuepress/.cache/
+/docs/.vuepress/.temp/
+/.github/webhooks/hooks.json

.nvmrc

@@ -0,0 +1 @@
+v20.2.0

.textlintrc.js

@@ -4,9 +4,9 @@ module.exports = {
     'no-start-duplicated-conjunction': {
       interval : 2, // interval of sentences
     },
-    /*'max-comma': {
+    'max-comma': {
       max : 4,
-    },*/
+    },
     /*'no-dead-link': {
       checkRelative: true,
       baseURI: null,
@@ -28,10 +28,10 @@ module.exports = {
       // Misspellings to be ignored (case-insensitive)
       ignore: [],
     },
-    /*'write-good': {
+    'write-good': {
       passive: false,
       thereIs: false
-    },*/
+    },
     'apostrophe': true,
   },
   filters: {

docs/.vuepress/config.github.js

@@ -0,0 +1,11 @@
+import { defineUserConfig } from 'vuepress'
+import meta from './config/meta'
+import theme from './config/theme'
+import plugins from './config/plugins'
+
+export default defineUserConfig({
+  base: "/ocelot.social/",
+  ...meta,
+  theme,
+  plugins,
+})

docs/.vuepress/config.js

@@ -1,70 +1,24 @@
-const path = require('path')
-module.exports = {
-  title: 'Ocelot Social',
-  description: 'ocelot.social is free and open source software program code to run social networks. Its development is supported by a community of programmers and interested network operators.',
-  head: [
-    ['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}]
-  ],
-  theme: 'vuepress-theme-book',
-  themeConfig: {
-    logo: "/logo.svg",
-    searchPlaceholder: "Search...",
-    lastUpdated: "Last Updated",
-    docsRepo: "https://github.com/Ocelot-Social-Community/ocelot.social/",
-    docsDir: "docs",
-    editLinks: true,
-    editLinkText: 'Edit this page on Github',
-    nav: [
-      { text: 'Ocelot.Social', link: '/' },
-      {
-        text: 'Github',
-        link:
-          'https://github.com/Ocelot-Social-Community'
-      },
-    ],
-    sidebar: {
-      '/': [
-        {
-          title: '',
-          collapsable: false,
-          sidebarDepth: 0,
-          children: [
-              ['/', 'Ocelot.Social'],
-              ['/code-of-conduct', 'Code of Conduct'],
-              ['/contributing', 'Contributing'],
-              ['/feature-specification', 'Feature Specification'],
-              ['/license', 'License']
-          ]
-        },
-        {
-          title: 'Tech',
-          collapsable: true,
-          sidebarDepth: 0,
-          children: [
-              ['/tech/neo4j', 'Neo4J'],
-              ['/tech/backend', 'Backend'],
-              ['/tech/webapp', 'WebApp']
-          ]
-        },
-        {
-          title: 'Testing',
-          collapsable: true,
-          sidebarDepth: 0,
-          children: [
-              ['test/', 'Testing'],
-              ['/test/cypress', 'End-To-End Tests'],
-              ['/test/webapp', 'Frontend Tests'],
-              ['/test/backend', 'Backend Tests']
-          ]
-        }
-      ]
+import { defineUserConfig } from 'vuepress'
+import meta from './config/meta'
+import theme from './config/theme'
+import plugins from './config/plugins'
+
+export default defineUserConfig({
+  ...meta,
+  theme,
+  plugins,
+  locales:{
+    // The key is the path for the locale to be nested under.
+    // As a special case, the default locale can use '/' as its path.
+    '/en/': {
+      lang: 'en-US', // this will be set as the lang attribute on <html>
+      title: 'Ocelot.Social',
+      // description: ''
     },
-  },
-  configureWebpack: {
-    resolve: {
-      alias: {
-        '@images': path.resolve(__dirname, '../images')
-      }
+    '/de/': {
+      lang: 'de-DE',
+      title: 'Ocelot.Social',
+      // description: ''
     }
-  },
-}  
+  }
+})

docs/.vuepress/config/meta.js

@@ -0,0 +1,7 @@
+export default {
+  title: 'Ocelot.Social',
+  // description: 'Free and open-source social network for active citizenship.',
+  head: [
+    ['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}]
+  ],
+}

docs/.vuepress/config/plugins.js

@@ -0,0 +1,22 @@
+import { searchProPlugin } from 'vuepress-plugin-search-pro'
+import { redirectPlugin } from 'vuepress-plugin-redirect'
+
+export default [
+  searchProPlugin({
+    indexContent: true,
+    autoSuggestions: true,
+    customFields: [
+      {
+        getter: (page) => page.frontmatter.category,
+        formatter: "Category: $content",
+      },
+      {
+        getter: (page) => page.frontmatter.tag,
+        formatter: "Tag: $content",
+      },
+    ],
+  }),
+  redirectPlugin({
+    autoLocale: true,
+  })
+]

docs/.vuepress/config/theme.js

@@ -0,0 +1,44 @@
+import { hopeTheme } from 'vuepress-theme-hope'
+
+export default hopeTheme({
+  favicon: 'favicon.ico',
+  logo: '/logo.svg',
+  docsRepo: 'https://github.com/Ocelot-Social-Community/ocelot.social',
+  docsBranch: 'master',
+  docsDir: 'docs',
+  editLink: true,
+  lastUpdated: false,
+  contributors: false,
+  displayFooter: true,
+  print: false,
+  copyright: '&copy; by <a href="https://busfaktor.org" target="_blank">busFaktor() e.V.</a> & Authors | <a href="/impressum/">Impressum</a>',
+  footer: 'Released under the <a class="vt-link link link" href="https://opensource.org/licenses/MIT" target="_blank" rel="noopener noreferrer"><!--[-->MIT License<!--]--><!----></a>.',
+  navbar: [
+    { 
+      text: 'Documentation', link: 'https://docs.ocelot.social/' 
+    },
+    { 
+      text: 'Demo', link: 'https://stage.ocelot.social/' 
+    },
+    {
+      text: 'Github',
+      link: 'https://github.com/Ocelot-Social-Community'
+    },
+    {
+      text: 'Impressum',
+      link: '/impressum/'
+    },
+  ],
+  plugins: {
+    mdEnhance: {
+      align: true,
+      demo: true,
+      imgLazyload: true,
+      imgMark: true,
+      imgSize: true,
+      sub: true,
+      sup: true,
+      vPre: true,
+    }
+  }
+})

docs/.vuepress/styles/palette.scss

@@ -0,0 +1 @@
+$theme-color: #17b53f;