prep/v1.5.2 (#105)

### 📖 Summary

- updates changelog
- bumps package / docs version

### 📑 Test Plan

✅ CI pipeline tests (Default)

### 💬 Details

_No response_

### 📚 Additional Notes

_No response_

Reviewed-on: #105

.woodpecker/ci.yml

@@ -89,7 +89,7 @@ steps:
         from_secret: ci_token
       base_url: https://gitea.ocram85.com
       title: ${CI_COMMIT_TAG}
-      note: "> :bulb: **Note:** Please refer to See [CHANGELOG.md](src/branch/${CI_REPO_DEFAULT_BRANCH}/CHANGELOG.md) for details."
+      note: "> :bulb: **Note:** Please refer to [CHANGELOG.md](src/branch/${CI_REPO_DEFAULT_BRANCH}/CHANGELOG.md) for details."
     when:
       event: [tag]
       branch: ${CI_REPO_DEFAULT_BRANCH}

CHANGELOG.md

@@ -1,3 +1,14 @@
+## [v1.5.2](https://gitea.ocram85.com/arkanum/arkanum/releases/tag/v1.5.2) - 2024-06-04
+
+* 🐛 BUGFIXES
+  * Fix typo (#104)
+* ✨ FEATURES
+  * Add blog feature to docs (#101)
+* 🛠️ ENHANCEMENTS
+  * Add gitea icon (#102)
+* 🤖 DEPENDENCIES
+  * Chore(deps): update quay.io/linuxserver.io/code-server docker tag to v4.89.1 (#100)
+
 ## [v1.5.1](https://gitea.ocram85.com/arkanum/arkanum/releases/tag/v1.5.1) - 2024-05-22
 
 * 🐛 BUGFIXES

Dockerfile

@@ -1,4 +1,4 @@
-FROM quay.io/linuxserver.io/code-server:4.89.0
+FROM quay.io/linuxserver.io/code-server:4.89.1
 
 #LABEL build_version=""
 LABEL maintainer="OCram85"

Dockerfile.vitepress

@@ -6,7 +6,7 @@ ENV NODE_ENV=production
 RUN bun install --frozen-lockfile
 RUN bun run --vite docs:build
 
-FROM caddy:2.7.6-alpine as prod
+FROM caddy:2.8.1-alpine as prod
 
 COPY --from=builder /app/docs/.vitepress/dist/ /arkanum-docs/
 COPY Caddyfile /etc/caddy

docs/.vitepress/config.mjs

@@ -1,8 +1,9 @@
 import { defineConfig } from 'vitepress'
 
-import { devDependencies, version } from '../../package.json'
+import { version } from '../../package.json'
 import navbar from './navbar.mjs'
 import { SidebarItems } from './sidebar.mjs'
+import { brandIcons } from './theme/icons.mjs'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -17,7 +18,7 @@ export default defineConfig({
       {
         async: '',
         defer: '',
-        src: 'https://umami.cafs.komm-one.net/script.js',
+        src: 'https://umami.ocram85.com/script.js',
         'data-website-id': 'e76d99a0-a185-4151-8a68-0fb44c6f0dc0',
         'data-domains': 'arkanum.dev',
         'data-do-not-track': 'true',
@@ -40,7 +41,7 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: navbar.getItems(version),
     sidebar: SidebarItems,
-    socialLinks: [{ icon: 'github', link: 'https://gitea.ocram85.com/arkanum/arkanum' }],
+    socialLinks: [{ icon: {svg: brandIcons.giteaAlt}, link: 'https://gitea.ocram85.com/arkanum/arkanum' }],
     footer: {
       message: 'Released under the AGPLv3 License.',
       copyright: 'Copyright © 2022-present OCram85 <me@ocram85.com>',

docs/.vitepress/navbar.mjs

@@ -14,6 +14,7 @@ function getItems(version) {
 
   return [
     { text: 'Home', link: '/' },
+    { text: 'Blog', link: '/blog' },
     { text: 'Guide', link: '/guide/about' },
     {
       text: nver,

docs/.vitepress/theme/components/Blog.vue

@@ -0,0 +1,51 @@
+<script setup>
+  import Posts from './Posts.vue'
+</script>
+
+<template>
+  <div class="blog-container">
+    <h1>Blog</h1>
+    <h2>⭐ Featured Articles</h2>
+    <Posts featured/>
+    <h2>📰 All Posts</h2>
+    <Posts/>
+  </div>
+</template>
+
+<style scoped>
+  .blog-container {
+    margin: auto;
+    width: 100%;
+    max-width: 1280px;
+    padding: 0 64px;
+
+  }
+
+  h1, h2, h3 {
+    position: relative;
+    font-weight: 600;
+    outline: none;
+  }
+
+  h1 {
+    letter-spacing: -0.02em;
+    line-height: 40px;
+    font-size: 32px;
+    margin-top: 32px;
+  }
+
+  h2 {
+    margin: 40px 0 16px;
+    border-top: 1px solid var(--vp-c-divider);
+    padding-top: 24px;
+    letter-spacing: -0.02em;
+    line-height: 32px;
+    font-size: 24px;
+  }
+
+  h3 {
+    margin: 32px 0 0;
+    letter-spacing: -0.01em;
+    font-size: 20px;
+  }
+</style>

docs/.vitepress/theme/components/Post.vue

@@ -0,0 +1,142 @@
+<script setup>
+  import { computed } from 'vue'
+  import { withBase } from 'vitepress'
+  import Badge from 'vitepress/dist/client/theme-default/components/VPBadge.vue'
+
+  const props = defineProps({
+    image: {
+      type: String,
+      default: 'placeholder.jpg',
+    },
+    title: {
+      type: String,
+      required: true,
+    },
+    tag: {
+      type: String,
+      default: 'no-tag',
+    },
+    url: {
+      type: String,
+      required: true,
+    },
+    featured: {
+      type: Boolean,
+      default: false,
+    },
+    date: {
+      type: String,
+      default: '2020-01-01'
+    }
+  })
+
+  const normTitle = computed(() => {
+    if (props.title.length > 50) {
+      return props.title.slice(0, 50) + '...'
+    } else {
+      return props.title
+    }
+  })
+
+  const normImage = computed(() => {
+    if (props.image !== null) return withBase(props.image)
+    else {
+      return withBase('placeholder.jpg')
+    }
+  })
+
+  const normTag = computed(() => {
+    if (props.tag !== null) return props.tag.toUpperCase()
+    else {
+      return 'EMPTY-TAG'
+    }
+  })
+</script>
+
+<template>
+  <article class="card">
+    <div class="card-header">
+      <img :src="normImage" />
+    </div>
+    <div class="card-content">
+      <div class="badge-container">
+        <Badge :text="normTag" type="tip" />
+      </div>
+      <h3>{{ normTitle }}</h3>
+      <a :href="url">Read More</a>
+    </div>
+  </article>
+</template>
+
+<style scoped>
+  .card {
+    margin: 15px;
+    padding: 0px;
+    background-color: var(--vp-c-bg-soft);
+    border-color: var(--vp-c-brand-2);
+    border-style: solid;
+    border-width: 1px;
+    border-radius: 10px;
+    width: 325px;
+    /*height: 450px; */
+    overflow: hidden;
+    box-shadow: 0px 8px 16px var(--vp-c-brand-soft);
+    position: relative;
+    top: 0;
+  }
+
+  .card:hover {
+    border-color: var(--vp-c-brand-1);
+    filter: brightness(125%);
+    transition: 0.25s;
+    box-shadow: 0px 16px 32px var(--vp-c-brand-soft);
+    /*top: -10px;*/
+  }
+
+  .card-header {
+    width: 100%;
+    height: 200px;
+  }
+  .card-header img {
+    width: 100%;
+    height: 100%;
+    object-fit: cover;
+  }
+
+  .card-content {
+    padding: 10px;
+    height: 200px;
+  }
+
+  .card-content h3 {
+    margin-top: 5px;
+    height: 90px;
+  }
+
+  .badge-container {
+    margin: 15px;
+  }
+
+  h3 {
+    position: relative;
+    font-weight: 600;
+    outline: none;
+
+    margin: 32px 0 0;
+    letter-spacing: -0.01em;
+    line-height: 28px;
+    font-size: 20px;
+  }
+
+  a {
+    font-weight: 500;
+    color: var(--vp-c-brand-1);
+    text-decoration: underline;
+    text-underline-offset: 2px;
+    transition: color 0.025s, opacity 0.25s;
+  }
+
+  a:hover {
+    color: var(--vp-c-brand-2);
+  }
+</style>

docs/.vitepress/theme/components/Posts.vue

@@ -0,0 +1,53 @@
+<script setup>
+  import { data } from './posts.data.js'
+  import Post from './Post.vue'
+
+  const props = defineProps({
+    tagFilter: {
+      type: String,
+      default: 'none',
+    },
+    featured: {
+      type: Boolean,
+      default: false,
+    },
+  })
+
+  const posts = data.filter((el) => {
+    if (!props.featured) {
+      if (props.tagFilter.toLowerCase() === 'none') {
+        return true
+      } else if (props.tagFilter.toLowerCase() === el.frontmatter.tag.toLowerCase()) {
+        return true
+      } else {
+        return false
+      }
+    } else {
+      if (el.frontmatter.featured) {
+        return true
+      } else return false
+    }
+  })
+</script>
+
+<template>
+  <section class="card-container">
+    <Post
+      :image="post.frontmatter.image"
+      :title="post.frontmatter.title"
+      :tag="post.frontmatter.tag"
+      :url="post.url"
+      :date="post.frontmatter.date"
+      v-for="post in posts"
+    />
+  </section>
+</template>
+
+<style scoped>
+  .card-container {
+    display: flex;
+    justify-content: center;
+    flex-wrap: wrap;
+    flex-direction: row;
+  }
+</style>

docs/.vitepress/theme/components/posts.data.js

@@ -0,0 +1,10 @@
+import { createContentLoader } from 'vitepress'
+
+export default createContentLoader('posts/**/*.md', {
+  excerpt: false,
+  transform(raw) {
+    return raw.sort((a, b) => {
+      return +new Date(b.frontmatter.date) - +new Date(a.frontmatter.date)
+    })
+  }
+})

docs/.vitepress/theme/icons.mjs

@@ -0,0 +1,5 @@
+export const brandIcons = {
+  gitea: '<svg version="1.1" id="main_outline" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 640 640" style="enable-background:new 0 0 640 640;" xml:space="preserve"><g><path id="teabag" style="fill:#FFFFFF" d="M395.9,484.2l-126.9-61c-12.5-6-17.9-21.2-11.8-33.8l61-126.9c6-12.5,21.2-17.9,33.8-11.8c17.2,8.3,27.1,13,27.1,13l-0.1-109.2l16.7-0.1l0.1,117.1c0,0,57.4,24.2,83.1,40.1c3.7,2.3,10.2,6.8,12.9,14.4c2.1,6.1,2,13.1-1,19.3l-61,126.9C423.6,484.9,408.4,490.3,395.9,484.2z"/><g><g><path style="fill:#609926" d="M622.7,149.8c-4.1-4.1-9.6-4-9.6-4s-117.2,6.6-177.9,8c-13.3,0.3-26.5,0.6-39.6,0.7c0,39.1,0,78.2,0,117.2c-5.5-2.6-11.1-5.3-16.6-7.9c0-36.4-0.1-109.2-0.1-109.2c-29,0.4-89.2-2.2-89.2-2.2s-141.4-7.1-156.8-8.5c-9.8-0.6-22.5-2.1-39,1.5c-8.7,1.8-33.5,7.4-53.8,26.9C-4.9,212.4,6.6,276.2,8,285.8c1.7,11.7,6.9,44.2,31.7,72.5c45.8,56.1,144.4,54.8,144.4,54.8s12.1,28.9,30.6,55.5c25,33.1,50.7,58.9,75.7,62c63,0,188.9-0.1,188.9-0.1s12,0.1,28.3-10.3c14-8.5,26.5-23.4,26.5-23.4s12.9-13.8,30.9-45.3c5.5-9.7,10.1-19.1,14.1-28c0,0,55.2-117.1,55.2-231.1C633.2,157.9,624.7,151.8,622.7,149.8z M125.6,353.9c-25.9-8.5-36.9-18.7-36.9-18.7S69.6,321.8,60,295.4c-16.5-44.2-1.4-71.2-1.4-71.2s8.4-22.5,38.5-30c13.8-3.7,31-3.1,31-3.1s7.1,59.4,15.7,94.2c7.2,29.2,24.8,77.7,24.8,77.7S142.5,359.9,125.6,353.9z M425.9,461.5c0,0-6.1,14.5-19.6,15.4c-5.8,0.4-10.3-1.2-10.3-1.2s-0.3-0.1-5.3-2.1l-112.9-55c0,0-10.9-5.7-12.8-15.6c-2.2-8.1,2.7-18.1,2.7-18.1L322,273c0,0,4.8-9.7,12.2-13c0.6-0.3,2.3-1,4.5-1.5c8.1-2.1,18,2.8,18,2.8l110.7,53.7c0,0,12.6,5.7,15.3,16.2c1.9,7.4-0.5,14-1.8,17.2C474.6,363.8,425.9,461.5,425.9,461.5z"/><path style="fill:#609926" d="M326.8,380.1c-8.2,0.1-15.4,5.8-17.3,13.8c-1.9,8,2,16.3,9.1,20c7.7,4,17.5,1.8,22.7-5.4c5.1-7.1,4.3-16.9-1.8-23.1l24-49.1c1.5,0.1,3.7,0.2,6.2-0.5c4.1-0.9,7.1-3.6,7.1-3.6c4.2,1.8,8.6,3.8,13.2,6.1c4.8,2.4,9.3,4.9,13.4,7.3c0.9,0.5,1.8,1.1,2.8,1.9c1.6,1.3,3.4,3.1,4.7,5.5c1.9,5.5-1.9,14.9-1.9,14.9c-2.3,7.6-18.4,40.6-18.4,40.6c-8.1-0.2-15.3,5-17.7,12.5c-2.6,8.1,1.1,17.3,8.9,21.3c7.8,4,17.4,1.7,22.5-5.3c5-6.8,4.6-16.3-1.1-22.6c1.9-3.7,3.7-7.4,5.6-11.3c5-10.4,13.5-30.4,13.5-30.4c0.9-1.7,5.7-10.3,2.7-21.3c-2.5-11.4-12.6-16.7-12.6-16.7c-12.2-7.9-29.2-15.2-29.2-15.2s0-4.1-1.1-7.1c-1.1-3.1-2.8-5.1-3.9-6.3c4.7-9.7,9.4-19.3,14.1-29c-4.1-2-8.1-4-12.2-6.1c-4.8,9.8-9.7,19.7-14.5,29.5c-6.7-0.1-12.9,3.5-16.1,9.4c-3.4,6.3-2.7,14.1,1.9,19.8C343.2,346.5,335,363.3,326.8,380.1z"/></g></g></g></svg>',
+  mail: '<?xml version="1.0" encoding="iso-8859-1"?><svg fill="#000000" height="800px" width="800px" version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 75.294 75.294" xml:space="preserve"><g><path d="M66.097,12.089h-56.9C4.126,12.089,0,16.215,0,21.286v32.722c0,5.071,4.126,9.197,9.197,9.197h56.9c5.071,0,9.197-4.126,9.197-9.197V21.287C75.295,16.215,71.169,12.089,66.097,12.089z M61.603,18.089L37.647,33.523L13.691,18.089H61.603z M66.097,57.206h-56.9C7.434,57.206,6,55.771,6,54.009V21.457l29.796,19.16c0.04,0.025,0.083,0.042,0.124,0.065c0.043,0.024,0.087,0.047,0.131,0.069c0.231,0.119,0.469,0.215,0.712,0.278c0.025,0.007,0.05,0.01,0.075,0.016c0.267,0.063,0.537,0.102,0.807,0.102c0.001,0,0.002,0,0.002,0c0.002,0,0.003,0,0.004,0c0.27,0,0.54-0.038,0.807-0.102c0.025-0.006,0.05-0.009,0.075-0.016c0.243-0.063,0.48-0.159,0.712-0.278c0.044-0.022,0.088-0.045,0.131-0.069c0.041-0.023,0.084-0.04,0.124-0.065l29.796-19.16v32.551C69.295,55.771,67.86,57.206,66.097,57.206z"/></g></svg>',
+  giteaAlt: '<?xml version="1.0" encoding="utf-8"?><svg fill="#000000" width="800px" height="800px" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><path d="M5.583 7.229c-2.464-0.005-5.755 1.557-5.573 5.479 0.281 6.125 6.557 6.693 9.068 6.745 0.271 1.146 3.224 5.109 5.411 5.318h9.573c5.74-0.38 10.036-17.365 6.854-17.427-5.271 0.25-8.396 0.375-11.073 0.396v5.297l-0.839-0.365-0.005-4.932c-3.073 0-5.781-0.141-10.917-0.396-0.646-0.005-1.542-0.115-2.5-0.115zM5.927 9.396h0.297c0.349 3.141 0.917 4.974 2.068 7.781-2.938-0.349-5.432-1.198-5.891-4.38-0.24-1.646 0.563-3.365 3.526-3.401zM17.339 12.479c0.198 0.005 0.406 0.042 0.594 0.13l1 0.432-0.714 1.302c-0.109 0-0.219 0.016-0.323 0.052-0.464 0.151-0.708 0.604-0.542 1.021 0.036 0.083 0.089 0.161 0.151 0.229l-1.234 2.25c-0.099 0-0.203 0.016-0.297 0.052-0.464 0.146-0.708 0.604-0.542 1.016 0.172 0.417 0.682 0.63 1.151 0.479 0.464-0.146 0.703-0.604 0.536-1.021-0.047-0.109-0.115-0.208-0.208-0.292l1.203-2.188c0.13 0.010 0.26 0 0.391-0.042 0.104-0.031 0.198-0.083 0.281-0.151 0.464 0.198 0.844 0.354 1.12 0.49 0.406 0.203 0.552 0.339 0.599 0.49 0.042 0.146-0.005 0.427-0.24 0.922-0.172 0.37-0.458 0.896-0.797 1.51-0.115 0-0.229 0.016-0.333 0.052-0.469 0.151-0.708 0.604-0.542 1.021 0.167 0.411 0.682 0.625 1.146 0.479 0.469-0.151 0.708-0.604 0.542-1.021-0.042-0.099-0.104-0.193-0.182-0.271 0.333-0.609 0.62-1.135 0.807-1.526 0.25-0.536 0.38-0.938 0.266-1.323s-0.469-0.635-0.932-0.865c-0.307-0.151-0.693-0.313-1.146-0.505 0.005-0.109-0.010-0.214-0.052-0.318s-0.109-0.198-0.193-0.281l0.703-1.281 3.901 1.682c0.703 0.307 0.995 1.057 0.651 1.682l-2.682 4.906c-0.339 0.625-1.182 0.885-1.885 0.578l-5.516-2.38c-0.703-0.307-0.995-1.057-0.656-1.682l2.682-4.906c0.234-0.432 0.708-0.688 1.208-0.708h0.083z"/></svg>'
+}

docs/.vitepress/theme/index.js

@@ -3,6 +3,8 @@ import { h } from 'vue'
 import DefaultTheme from 'vitepress/theme'
 import './style.css'
 
+import Blog from './components/Blog.vue'
+
 /** @type {import('vitepress').Theme} */
 export default {
   extends: DefaultTheme,
@@ -12,6 +14,6 @@ export default {
     })
   },
   enhanceApp({ app, router, siteData }) {
-    // ...
+    app.component('blog', Blog)
-  }
+  },
 }

docs/blog.md

@@ -0,0 +1,3 @@
+---
+layout: blog
+---

docs/posts/2024/next-release.md

@@ -0,0 +1,12 @@
+---
+author: OCram85
+title: 'Working on Arkanum 2.0.0'
+tag: 'roadmap'
+image: 'screens/screen1.png'
+date: '2024-06-06'
+---
+
+# Working on Arkanum 2.0
+
+Lorem ipsum dolor sit amet consectetur adipisicing elit. Rerum dolorum ab optio, dolore saepe accusamus
+au

package.json

@@ -1,6 +1,6 @@
 {
   "name": "arkanum-docs",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "type": "module",
   "repository": {
     "type": "git",