feat: Update content with the latest features

aplosdev · May 5, 2024 · ffb89ab · ffb89ab
1 parent 4b9eb8e
commit ffb89ab
Show file tree

Hide file tree

Showing 12 changed files with 78 additions and 20 deletions.
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     "pages:preview": "vitepress preview pages"
   },
   "dependencies": {
-    "aplos": "1.3.4-3"
+    "aplos": "1.4.0"
   },
   "devDependencies": {
     "sass": "^1.75.0",

diff --git a/pages/.vitepress/config.mts b/pages/.vitepress/config.mts
@@ -52,9 +52,9 @@ export default defineConfig({
 
     markdown: {
       container: {
-        warningLabel: "⚠ Warning",
+        warningLabel: "Warning",
         tipLabel: "Tip",
-        dangerLabel: "⚠ Danger",
+        dangerLabel: "Danger",
         infoLabel: "Info",
       },
       theme: {

diff --git a/pages/blog/posts/first-blog.md b/pages/blog/posts/first-blog.md
@@ -3,6 +3,8 @@ layout: blog
 title: First Blog
 author: Gabriel Cozma
 description: This is my first ever demo blog for Aplos!
+comments: activitypub
+post: https://fosstodon.org/@gregorni/112379470950032296
 date: 2024-03-10T21:32:00+02:00
 next: Ipsum
 tags:
@@ -11,6 +13,10 @@ tags:
  - example
 ---
 
+> [!INFO] Info
+> Comments are via ActivityPub. I took a random post as demo, credits to the post: <https://fosstodon.org/@gregorni/112379470950032296>.
+
+
 Ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim aeque doleamus animo, cum corpore dolemus, fieri tamen permagna accessio potest, si aliquod aeternum et infinitum impendere malum nobis opinemur. Quod idem licet transferre in voluptatem, ut postea variari voluptas distinguique possit, augeri amplificarique non possit. At.
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
@@ -23,4 +29,4 @@ Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cu
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona.
 
-Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
+Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
diff --git a/pages/blog/posts/ipsum.md b/pages/blog/posts/ipsum.md
@@ -4,6 +4,7 @@ title: "Ipsum"
 author: Gabriel Cozma
 description: Why Ipsum is the best.
 date: 2024-03-10T21:33:00+02:00
+comments: giscus
 prev: First Blog
 next: Lorem
 tags:
@@ -24,4 +25,4 @@ Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cu
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona.
 
-Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
+Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam.
diff --git a/pages/blog/posts/lorem.md b/pages/blog/posts/lorem.md
@@ -4,6 +4,7 @@ title: "Lorem"
 author: Gabriel Cozma
 description: Why Lorem is the best.
 date: 2024-03-10T21:34:00+02:00
+comments: giscus
 prev: Ipsum
 tags:
  - demo
@@ -19,4 +20,4 @@ Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cu
 
 Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis.
 
-Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo.
+Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo.
diff --git a/pages/demo.md b/pages/demo.md
@@ -38,7 +38,7 @@ Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cu
 
 VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
 
-**Input**
+### Input
 
 ````md
 ```js{4}
@@ -52,7 +52,7 @@ export default {
 ```
 ````
 
-**Output**
+### Output
 
 ```js{4}
 export default {
@@ -106,7 +106,7 @@ The message you want to share
 :::
 ```
 
-**Input**
+### Input
 
 ```md
 ::: info
@@ -130,7 +130,7 @@ This is a details block.
 :::
 ```
 
-**Output**
+### Output
 
 ::: info
 This is an info box.

diff --git a/pages/features.md b/pages/features.md
@@ -4,7 +4,7 @@ layout: simple
 
 # Features
 
-> [!WARNING] ⚠️ Work in Progress
+> [!WARNING] Work in Progress
 > You found an work in progress page, please come back later.
 
 [[toc]]

diff --git a/pages/guide/edit-configuration.md b/pages/guide/edit-configuration.md
@@ -8,7 +8,7 @@ To customize the theme, you can change the following variables inside the `theme
 
 ### Navigation Island
 
-You can change multuple things in the navigation island:
+You can change multiple things in the navigation island:
 
 Customizing the navigation links in your Aplós template is a straightforward process, specifically in the `nav` section:
 
@@ -25,7 +25,7 @@ nav: {
     },
 ```
 
-### Footer
+### Footer {#footer-config}
 
 Customizing the Footer in your Aplós template is a straightforward process, specifically in the `footer` section:
 
@@ -63,7 +63,12 @@ Customizing the Blog in your Aplós template is a straightforward process, speci
     },
 ```
 
-The `data` object contains the variables to make the comments work, for more information check [Giscus](https://giscus.app/) (the comments provider used in this project).
+> Make sure to replace the `repo`, `repoid`, and `categoryid` with your own values.
+
+The `data` object contains the variables to make the [Giscus](https://giscus.app/) comments show, for more information check the [Giscus documentation](https://giscus.app/).
+
+>[!WARNING] Warning
+> The variables above are only needed if you use Giscus as the comment provider in your blog post. If you use ActivityPub, you can ignore these variables.
 
 ## Customizing Colors
 

diff --git a/pages/guide/index.md b/pages/guide/index.md
@@ -167,6 +167,41 @@ tags:
 ---
 ```
 
+#### Comments
+
+Aplós supports two comment systems: [Giscus](https://giscus.app) and ActivityPub posts. To enable one of them, follow these steps:
+
+- **If you want Giscus**: inside your blog post, add the following inside frontmatter:
+
+```yaml
+comments: giscus
+```
+
+You also need to add the following inside the `config.mts` file, in the `theme` object:
+
+```ts
+    blog: {
+      data: {
+        repo: "yourusername/yourrepo",
+        repoid: "your-repo-id",
+        categoryid: "your-category-id",
+      },
+    },
+```
+
+Make sure to edit the `repo`, `repoid`, and `categoryid` with your own values. Once that, you don't need to do anything else, the comments will right there!
+
+---
+
+- If you want **ActivityPub**: inside your blog post, add the following inside frontmatter:
+
+```yaml
+comments: activitypub
+post: https://mastodon.example/@yourusername/1234567890
+```
+
+Make sure to edit the `post` link with your own post link. Once that, you don't need to do anything else, the comments will right there!
+
 ### Automatically Update Aplós
 
 To automatically update Aplós, which is an NPM Package hosted on GitHub, you can use Dependabot. Follow these steps to set it up:

diff --git a/pages/index.md b/pages/index.md
@@ -15,6 +15,10 @@ A sleek, contemporary, and purposefully designed VitePress theme & template. It
 - <span class="emoji">🖋️</span> Utilizes premium fonts: Inter for text and Geist Mono for code snippets.
 - <span class="emoji">💻</span> Local development made easy with NPM/PNPM integration.
 - <span class="emoji">📦</span> Every asset is local, nothing is pulled from the internet.
+- <span class="emoji">🔧</span> Customizable configuration for a personalized touch.
+- <span class="emoji">✍️</span> Perfect integration for blogs, documentation, and personal websites.
+- <span class="emoji">💬</span> Giscus and Activitypub/Mastodon powered comments, for blog posts
+
 </section>
 
 <br>

diff --git a/pages/static.md b/pages/static.md
@@ -20,7 +20,7 @@ Once you've got it cloned, dive into the index.html file, make your tweaks, and
 
 Inside the `index.html` file, you'll find a style section with a customizable color palette. Want a change? Go for it! Modify the text, add elements as you wish. For a inspiration, check out the [Demo Page](/demo). Creating cards like an warning card? Just add an element with the id "`warning`", add in an `<h1 />` and a `<p />`, and you're good to go.
 
-> [!warning] ⚠ Warning
+> [!warning] Warning
 > Please note that this template may have a slight lag behind the latest version. This intentional approach allows for a greater focus on improving the main version rather than constantly catching up with every release. After about one point release (for example if the current version is `1.3.5` the static template is at `1.2.5`), the template will receive a polished update to the latest version.
 
 ::: details Heads Up

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml