Compare commits
1 Commits
master
...
10839c6339
Author | SHA1 | Date | |
---|---|---|---|
|
10839c6339 |
@ -1,56 +0,0 @@
|
||||
name: Deploy & Publish Image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
paths-ignore:
|
||||
- README.md
|
||||
- LICENSE
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
strategy:
|
||||
matrix:
|
||||
arch: [ "ubuntu-latest" ]
|
||||
git-version: [ "2.44.0" ]
|
||||
runs-on: ${{ matrix.arch }}
|
||||
|
||||
# Steps to run
|
||||
steps:
|
||||
# Checkout the repo
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
# Deploy to Dokku
|
||||
- name: Deploy to Dokku
|
||||
uses: dokku/github-action@master
|
||||
with:
|
||||
git_remote_url: "ssh://dokku@10.10.70.73:22/docs"
|
||||
ssh_private_key: ${{ secrets.DOKKU_SSH_PRIVATE_KEY }}
|
||||
|
||||
# Set up Docker Buildx
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
# Login to the Docker registry
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: git.rainnny.club
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_TOKEN }}
|
||||
|
||||
# Publish the image
|
||||
- name: Build Image
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
file: ./Dockerfile
|
||||
push: true
|
||||
tags: |
|
||||
git.rainnny.club/pulseapp/docs:${{ github.sha }}
|
||||
git.rainnny.club/pulseapp/docs:latest
|
||||
build-args: |
|
||||
GIT_REV=${{ gitea.sha }}
|
31
.gitea/workflows/deploy.yml
Normal file
31
.gitea/workflows/deploy.yml
Normal file
@ -0,0 +1,31 @@
|
||||
name: Deploy
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
paths-ignore:
|
||||
- README.md
|
||||
- LICENSE
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
strategy:
|
||||
matrix:
|
||||
arch: [ "ubuntu-latest" ]
|
||||
git-version: [ "2.44.0" ]
|
||||
runs-on: ${{ matrix.arch }}
|
||||
|
||||
# Steps to run
|
||||
steps:
|
||||
# Checkout the repo
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
# Deploy to Dokku
|
||||
- name: Deploy to Dokku
|
||||
uses: dokku/github-action@master
|
||||
with:
|
||||
git_remote_url: "ssh://dokku@10.10.70.73:22/docs"
|
||||
ssh_private_key: ${{ secrets.DOKKU_SSH_PRIVATE_KEY }}
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -6,6 +6,7 @@ node_modules
|
||||
.env*.local
|
||||
next-env.d.ts
|
||||
.sentryclirc
|
||||
.env
|
||||
sw.*
|
||||
workbox-*
|
||||
swe-worker-*
|
||||
|
11
Dockerfile
11
Dockerfile
@ -13,7 +13,7 @@ FROM base AS builder
|
||||
WORKDIR /usr/src/app
|
||||
COPY --from=depends /usr/src/app/node_modules ./node_modules
|
||||
COPY . .
|
||||
ENV NEXT_TELEMETRY_DISABLED=1
|
||||
ENV NEXT_TELEMETRY_DISABLED 1
|
||||
RUN bun run build
|
||||
|
||||
|
||||
@ -32,15 +32,14 @@ COPY --from=builder --chown=nextjs:nextjs /usr/src/app/.next ./.next
|
||||
COPY --from=builder --chown=nextjs:nextjs /usr/src/app/public ./public
|
||||
COPY --from=builder --chown=nextjs:nextjs /usr/src/app/next.config.mjs ./next.config.mjs
|
||||
COPY --from=builder --chown=nextjs:nextjs /usr/src/app/package.json ./package.json
|
||||
COPY --from=builder --chown=nextjs:nextjs /usr/src/app/docs ./docs
|
||||
|
||||
ENV NODE_ENV=production
|
||||
ENV NODE_ENV production
|
||||
|
||||
# Exposting on port 80 so we can
|
||||
# access via a reverse proxy for Dokku
|
||||
ENV HOSTNAME="0.0.0.0"
|
||||
ENV HOSTNAME "0.0.0.0"
|
||||
EXPOSE 80
|
||||
ENV PORT=80
|
||||
ENV PORT 80
|
||||
|
||||
USER nextjs
|
||||
CMD ["node", "server.js"]
|
||||
CMD node server.js
|
@ -1,2 +1,3 @@
|
||||
# docs
|
||||
The source coded for the Pulse App documentation site.
|
||||
|
||||
The public documentation for Pulse App.
|
90
config.json
90
config.json
@ -1,90 +0,0 @@
|
||||
{
|
||||
"siteName": "Pulse App",
|
||||
"ogApiUrl": "https://docs.pulseapp.cc/api/og?title={title}",
|
||||
"metadata": {
|
||||
"title": {
|
||||
"default": "Pulse Docs",
|
||||
"template": "%s • Pulse Docs"
|
||||
},
|
||||
"description": "A lightweight service monitoring solution for tracking the availability of whatever service your heart desires!",
|
||||
"openGraph": {
|
||||
"images": [
|
||||
{
|
||||
"url": "https://pulseapp.cc/media/logo.png",
|
||||
"width": 128,
|
||||
"height": 128
|
||||
}
|
||||
]
|
||||
},
|
||||
"twitter": {
|
||||
"card": "summary"
|
||||
}
|
||||
},
|
||||
"viewport": {
|
||||
"themeColor": "#A855F7"
|
||||
},
|
||||
"contentSource": "https://git.rainnny.club/PulseApp/docs-content.git",
|
||||
"contentEditUrl": "https://git.rainnny.club/PulseApp/docs-content/src/branch/master/{slug}{ext}",
|
||||
"socialLinks": [
|
||||
{
|
||||
"name": "GitHub",
|
||||
"tooltip": "View our Github",
|
||||
"logo": "./github.svg",
|
||||
"href": "https://github.com/PulseAppCC",
|
||||
"navbar": true
|
||||
},
|
||||
{
|
||||
"name": "Discord",
|
||||
"tooltip": "Join our Discord",
|
||||
"logo": "./discord.svg",
|
||||
"href": "https://discord.pulseapp.cc",
|
||||
"navbar": true
|
||||
},
|
||||
{
|
||||
"name": "Email",
|
||||
"tooltip": "Email us",
|
||||
"logo": "Mail",
|
||||
"href": "mailto:support@pulseapp.cc",
|
||||
"navbar": false
|
||||
}
|
||||
],
|
||||
"footer": {
|
||||
"homeUrl": "https://pulseapp.cc",
|
||||
"links": {
|
||||
"Resources": [
|
||||
{
|
||||
"name": "Support",
|
||||
"href": "https://support.pulseapp.cc"
|
||||
},
|
||||
{
|
||||
"name": "Jobs",
|
||||
"href": "https://jobs.pulseapp.cc"
|
||||
},
|
||||
{
|
||||
"name": "Developers",
|
||||
"shortName": "Devs",
|
||||
"href": "https://dev.pulseapp.cc",
|
||||
"external": true
|
||||
},
|
||||
{
|
||||
"name": "System Status",
|
||||
"shortName": "Status",
|
||||
"href": "https://status.pulseapp.cc",
|
||||
"external": true
|
||||
}
|
||||
],
|
||||
"Legal": [
|
||||
{
|
||||
"name": "Terms & Conditions",
|
||||
"shortName": "Terms",
|
||||
"href": "/legal/terms"
|
||||
},
|
||||
{
|
||||
"name": "Privacy Policy",
|
||||
"shortName": "Privacy",
|
||||
"href": "/legal/privacy"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
@ -1,10 +0,0 @@
|
||||
services:
|
||||
app:
|
||||
image: git.rainnny.club/pulseapp/docs:latest
|
||||
restart: unless-stopped
|
||||
container_name: docs
|
||||
ports:
|
||||
- "8080:80"
|
||||
volumes:
|
||||
- ./config.json:/usr/src/app/config.json
|
||||
- ./docs:/usr/src/app/docs
|
@ -1,9 +1,24 @@
|
||||
---
|
||||
title: 'Example'
|
||||
updated: '2024-10-06'
|
||||
title: '🚀 Introduction'
|
||||
published: '2024-10-06'
|
||||
summary: 'petentium usu tota noluisse errem elaboraret auctor.'
|
||||
order: 1
|
||||
---
|
||||
|
||||
# Hello World
|
||||
This is an example content file.
|
||||
> [!IMPORTANT]
|
||||
> These docs are currently a work in progress and are subject to change.
|
||||
|
||||
# Pulse App
|
||||
<span className="flex gap-2 items-center select-none">
|
||||
<Activity className="w-4 h-4 text-primary" /> <span>A lightweight service monitoring solution for tracking the availability of whatever service your heart desires!</span>
|
||||
</span>
|
||||
|
||||
## Getting Started
|
||||
Let's get you up and running—this will only take a few minutes! Start by [creating your account](#creating-your-account) and
|
||||
making your first status page. You can do this on our cloud or on your [own instance](/self-hosting). Once done, you can add
|
||||
your services and start monitoring them. See [Next Steps](#next-steps) for more.
|
||||
|
||||
### Creating your Account
|
||||
- First, head to our [Dashboard](https://pulseapp.cc/dashboard) and fill out the form. ![Registering](https://cdn.rainnny.club/auhNOjrcYz6u.png)
|
||||
- Next, complete the onboarding process and set up your first organization, and status page. ![Onboarding](https://cdn.rainnny.club/AfDgjHG5QTpZ.png)
|
||||
- Finally, you can [start monitoring your services](#next-steps)!
|
9
docs/👨🏼💻 Self Hosting/docker.mdx
Normal file
9
docs/👨🏼💻 Self Hosting/docker.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: '🐋 Docker'
|
||||
published: '2024-10-07'
|
||||
summary: 'petentium usu tota noluisse errem elaboraret auctor.'
|
||||
order: 4
|
||||
---
|
||||
|
||||
# 🐋 Deploying on Docker
|
||||
...
|
9
docs/🖥️ Service Monitoring/components.mdx
Normal file
9
docs/🖥️ Service Monitoring/components.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: '🧩 Components'
|
||||
published: '2024-10-07'
|
||||
summary: 'petentium usu tota noluisse errem elaboraret auctor.'
|
||||
order: 2
|
||||
---
|
||||
|
||||
# 🧩 Components
|
||||
...
|
9
docs/🖥️ Service Monitoring/supported-services.mdx
Normal file
9
docs/🖥️ Service Monitoring/supported-services.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: '✔️ Supported Services'
|
||||
published: '2024-10-07'
|
||||
summary: 'petentium usu tota noluisse errem elaboraret auctor.'
|
||||
order: 3
|
||||
---
|
||||
|
||||
# ✔️ Supported Services
|
||||
Below is a list of all the services that are currently supported by Pulse App. Are we missing a service? Please [open an issue](https://git.rainnny.club/PulseApp/API/issues)!
|
@ -20,12 +20,11 @@
|
||||
"@radix-ui/react-separator": "^1.1.0",
|
||||
"@radix-ui/react-slot": "^1.1.0",
|
||||
"@radix-ui/react-tooltip": "^1.1.3",
|
||||
"@vercel/og": "^0.6.3",
|
||||
"class-variance-authority": "^0.7.0",
|
||||
"clsx": "^2.1.1",
|
||||
"cmdk": "1.0.0",
|
||||
"framer-motion": "^11.11.1",
|
||||
"lucide-react": "^0.452.0",
|
||||
"lucide-react": "^0.447.0",
|
||||
"luxon": "^3.5.0",
|
||||
"next": "^15.0.0-canary.179",
|
||||
"next-themes": "^0.3.0",
|
||||
@ -33,7 +32,6 @@
|
||||
"react-dom": "^19.0.0-rc-1460d67c-20241003",
|
||||
"remark-gfm": "^4.0.0",
|
||||
"remote-mdx": "^0.0.8",
|
||||
"simple-git": "^3.27.0",
|
||||
"tailwind-merge": "^2.5.3",
|
||||
"tailwindcss-animate": "^1.0.7"
|
||||
},
|
||||
@ -42,8 +40,8 @@
|
||||
"@types/node": "^22.0.0",
|
||||
"@types/react": "^18",
|
||||
"@types/react-dom": "^18",
|
||||
"eslint": "^8",
|
||||
"eslint-config-next": "15.0.0",
|
||||
"eslint": "^9.0.0",
|
||||
"eslint-config-next": "14.2.14",
|
||||
"postcss": "^8",
|
||||
"tailwindcss": "^3.4.1",
|
||||
"typescript": "^5"
|
||||
|
@ -1,4 +1,4 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 127.14 96.36">
|
||||
<path fill="#5865f2"
|
||||
<path fill="#fff"
|
||||
d="M107.7,8.07A105.15,105.15,0,0,0,81.47,0a72.06,72.06,0,0,0-3.36,6.83A97.68,97.68,0,0,0,49,6.83,72.37,72.37,0,0,0,45.64,0,105.89,105.89,0,0,0,19.39,8.09C2.79,32.65-1.71,56.6.54,80.21h0A105.73,105.73,0,0,0,32.71,96.36,77.7,77.7,0,0,0,39.6,85.25a68.42,68.42,0,0,1-10.85-5.18c.91-.66,1.8-1.34,2.66-2a75.57,75.57,0,0,0,64.32,0c.87.71,1.76,1.39,2.66,2a68.68,68.68,0,0,1-10.87,5.19,77,77,0,0,0,6.89,11.1A105.25,105.25,0,0,0,126.6,80.22h0C129.24,52.84,122.09,29.11,107.7,8.07ZM42.45,65.69C36.18,65.69,31,60,31,53s5-12.74,11.43-12.74S54,46,53.89,53,48.84,65.69,42.45,65.69Zm42.24,0C78.41,65.69,73.25,60,73.25,53s5-12.74,11.44-12.74S96.23,46,96.12,53,91.08,65.69,84.69,65.69Z"/>
|
||||
</svg>
|
Before Width: | Height: | Size: 780 B After Width: | Height: | Size: 777 B |
@ -1,50 +1,5 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 96 96" id="Github-Octocat--Streamline-Svg-Logos.svg"
|
||||
height="98" width="98" stroke-width="1">
|
||||
<desc>Github Octocat Streamline Icon: https://streamlinehq.com</desc>
|
||||
<path fill="#9EDCF2"
|
||||
d="M74.4304 73.4278c0 5.0396-11.6744 9.1002-26.068 9.1002-14.3936 0-26.068-4.0969-26.068-9.1002 0-5.0396 11.6744-9.1002 26.068-9.1002 14.3936 0 26.068 4.0606 26.068 9.1002Z"></path>
|
||||
<mask id="a" width="30" height="25" x="33" y="70" maskUnits="userSpaceOnUse" style="mask-type:luminance">
|
||||
<path fill="#fff"
|
||||
d="M37.159 89.7428c.5801 2.7192 1.9941 4.3145 3.4081 5.2571h14.9012c1.8128-1.2327 3.6618-3.553 3.6618-7.9037V75.8568s.2175-2.7917 2.7917-3.6981c0 0 1.4865-1.0514-.1088-1.6315 0 0-7.0699-.5801-7.0699 5.2209v8.5564s.2901 3.1542-1.3777 4.4594V78.1772s.1088-3.3718 1.8491-4.6407c0 0 1.1602-2.0666-1.3777-1.5228 0 0-4.8583.6889-5.0759 6.381l-.1087 10.8768H47.492l-.1088-10.8768c-.2175-5.6559-5.0758-6.381-5.0758-6.381-2.5379-.5801-1.3777 1.5228-1.3777 1.5228 1.7402 1.2689 1.849 4.6407 1.849 4.6407v10.6955c-1.6678-1.1965-1.3777-4.5682-1.3777-4.5682v-8.5564c0-5.801-7.0699-5.2209-7.0699-5.2209-1.6315.5801-.1088 1.6315-.1088 1.6315 2.5379.9427 2.7917 3.6981 2.7917 3.6981v7.8676l.145 6.0184Z"></path>
|
||||
</mask>
|
||||
<g mask="url(#a)">
|
||||
<path fill="#7DBCE7"
|
||||
d="M74.4304 73.4276c0 5.0395-11.6744 9.1002-26.068 9.1002-14.3936 0-26.068-4.0969-26.068-9.1002 0-5.0396 11.6744-9.1003 26.068-9.1003 14.3936 0 26.068 4.0607 26.068 9.1003Z"></path>
|
||||
</g>
|
||||
<path fill="#9EDCF2"
|
||||
d="m18.5959 46.6347-.7614 2.6104s-.1812.9427.6889 1.124c.9426-.0363.8701-.9064.7976-1.1602l-.7251-2.5742Z"></path>
|
||||
<path fill="#010101"
|
||||
d="m94.3348 35.6491.0725-.3263c-7.65-1.5227-15.4812-1.559-20.2308-1.3414.7614-2.7917 1.0152-6.0548 1.0152-9.6441 0-5.1846-1.9578-9.3177-5.0758-12.4358.5438-1.7765 1.2689-5.72838-.7251-10.76795 0 0-3.5531-1.12392813-11.6382 4.2782-3.1542-.79763-6.526-1.19645-9.8978-1.19645-3.6981 0-7.4325.47133-10.9493 1.41398C28.5667-.0628898 24.9048 1.0973 24.9048 1.0973c-2.3929 5.98222-.9064 10.4417-.4713 11.5294-2.828 3.0455-4.532 6.9248-4.532 11.6744 0 3.5893.3988 6.8161 1.414 9.6078-4.7858-.1813-12.32702-.1088-19.72321 1.3777l.07251.3263c7.39619-1.4865 15.0099-1.5228 19.7594-1.3415.2176.5801.4714 1.1602.7252 1.704-4.7133.1451-12.72585.7614-20.41209 2.9368l.10877.3263C9.60483 37.0631 17.6899 36.483 22.3669 36.338c2.828 5.2208 8.3389 8.6289 18.2004 9.6803-1.4139.9427-2.8279 2.5379-3.408 5.2571-1.9216.9064-7.94 3.1543-11.5656-3.0817 0 0-2.0304-3.6981-5.9097-3.9882 0 0-3.7706-.0725-.2538 2.3567 0 0 2.5016 1.1964 4.2419 5.6559 0 0 2.2841 7.6137 13.1971 5.1483v7.795s-.2175 2.7917-2.7917 3.6981c0 0-1.5227 1.0514.1088 1.6315 0 0 7.0699.5801 7.0699-5.2208v-8.5564s-.29-3.408 1.3777-4.5682v14.0672s-.1087 3.3718-1.849 4.6408c0 0-1.1602 2.0666 1.3777 1.5227 0 0 4.8583-.6888 5.0758-6.381l.1088-14.2485h1.1602l.1088 14.2485c.2175 5.6559 5.0758 6.381 5.0758 6.381 2.5379.5801 1.3777-1.5227 1.3777-1.5227-1.7403-1.269-1.8491-4.6408-1.8491-4.6408V52.2543c1.6678 1.3052 1.3778 4.4595 1.3778 4.4595v8.5564c0 5.8009 7.0699 5.2208 7.0699 5.2208 1.6315-.5801.1087-1.6315.1087-1.6315-2.5379-.9426-2.7917-3.6981-2.7917-3.6981V53.9221c0-4.387-1.849-6.7073-3.6618-7.9038 10.5142-1.0514 15.5538-4.4232 17.8741-9.7166 4.6045.1088 12.9071.6889 20.8109 2.9368l.1088-.3263c-7.8676-2.2116-16.0976-2.7917-20.7746-2.9368.2175-.5438.3988-1.0876.5801-1.6677 4.8582-.1813 12.7258-.1813 20.412 1.3414Z"></path>
|
||||
<path fill="#F5CCB3"
|
||||
d="M64.8947 24.0835c2.2479 2.0666 3.5893 4.532 3.5893 7.1787 0 12.472-9.2815 12.7983-20.7383 12.7983-11.4569 0-20.7384-1.7403-20.7384-12.7983 0-2.6467 1.3052-5.1121 3.5531-7.1424 3.7344-3.4081 10.0429-1.5953 17.1853-1.5953 7.1424 0 13.4147-1.849 17.149 1.559Z"></path>
|
||||
<path fill="#fff"
|
||||
d="M40.8579 31.9148c0 3.4443-1.9216 6.1997-4.3144 6.1997-2.3929 0-4.3145-2.7917-4.3145-6.1997 0-3.4443 1.9216-6.1998 4.3145-6.1998 2.3928-.0362 4.3144 2.7555 4.3144 6.1998Z"></path>
|
||||
<path fill="#AF5C51"
|
||||
d="M39.4794 31.9872c0 2.2842-1.3052 4.1332-2.8642 4.1332-1.5953 0-2.8642-1.849-2.8642-4.1332 0-2.2841 1.3052-4.1331 2.8642-4.1331s2.8642 1.849 2.8642 4.1331Z"></path>
|
||||
<path fill="#fff"
|
||||
d="M64.0254 31.9148c0 3.4443-1.9216 6.1997-4.3145 6.1997s-4.3144-2.7917-4.3144-6.1997c0-3.4443 1.9215-6.1998 4.3144-6.1998 2.3567-.0362 4.3145 2.7555 4.3145 6.1998Z"></path>
|
||||
<path fill="#AF5C51"
|
||||
d="M62.6108 31.9872c0 2.2842-1.3053 4.1332-2.8643 4.1332-1.5952 0-2.8642-1.849-2.8642-4.1332 0-2.2841 1.3052-4.1331 2.8642-4.1331 1.5953 0 2.8643 1.849 2.8643 4.1331Z"></path>
|
||||
<path fill="#AF5C51"
|
||||
d="M48.9068 37.4257c0 .5801-.4713 1.0877-1.0877 1.0877-.5801 0-1.0877-.4714-1.0877-1.0877 0-.6164.4714-1.0877 1.0877-1.0877.5801 0 1.0877.4713 1.0877 1.0877Z"></path>
|
||||
<path fill="#AF5C51"
|
||||
d="M45.3171 40.1449c-.0725-.1813.0363-.3625.2176-.4351.1813-.0725.3625.0363.4351.2176.29.7976 1.0151 1.3052 1.849 1.3052.8339 0 1.559-.5438 1.8491-1.3052.0725-.1813.2537-.2901.435-.2176.1813.0726.2901.2538.2176.4351-.3626 1.0514-1.3778 1.7766-2.5017 1.7766-1.1239 0-2.1391-.7252-2.5017-1.7766Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M21.3518 45.0757c0 .29-.3263.5076-.7613.5076-.3988 0-.7614-.2176-.7614-.5076 0-.29.3263-.5076.7614-.5076.435 0 .7613.2176.7613.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M23.4544 46.2359c0 .29-.3263.5075-.7614.5075-.3988 0-.7614-.2175-.7614-.5075 0-.2901.3263-.5076.7614-.5076s.7614.2175.7614.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M24.7229 47.7586c0 .2901-.3263.5076-.7613.5076-.3988 0-.7614-.2175-.7614-.5076 0-.29.3263-.5076.7614-.5076.435-.0362.7613.2176.7613.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M25.8836 49.499c0 .29-.3263.5075-.7614.5075-.3988 0-.7614-.2175-.7614-.5075 0-.2901.3263-.5076.7614-.5076.4351-.0363.7614.2175.7614.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M27.1521 51.0941c0 .2901-.3263.5076-.7613.5076-.3988 0-.7614-.2175-.7614-.5076 0-.29.3263-.5076.7614-.5076.435 0 .7613.2176.7613.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M28.8924 52.5081c0 .2901-.3263.5076-.7614.5076-.3988 0-.7614-.2175-.7614-.5076 0-.29.3263-.5076.7614-.5076.4351-.0362.7614.2176.7614.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M31.3216 53.4146c0 .29-.3263.5075-.7614.5075-.3988 0-.7614-.2175-.7614-.5075 0-.2901.3263-.5076.7614-.5076s.7614.2175.7614.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M33.7517 53.4146c0 .29-.3263.5075-.7613.5075-.3988 0-.7614-.2175-.7614-.5075 0-.2901.3263-.5076.7614-.5076.435 0 .7613.2175.7613.5076Z"></path>
|
||||
<path fill="#C4E5D9"
|
||||
d="M36.2166 53.0157c0 .29-.3263.5076-.7614.5076-.3988 0-.7614-.2176-.7614-.5076 0-.29.3263-.5076.7614-.5076.3988 0 .7614.2176.7614.5076Z"></path>
|
||||
<svg width="98" height="96" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd"
|
||||
d="M48.854 0C21.839 0 0 22 0 49.217c0 21.756 13.993 40.172 33.405 46.69 2.427.49 3.316-1.059 3.316-2.362 0-1.141-.08-5.052-.08-9.127-13.59 2.934-16.42-5.867-16.42-5.867-2.184-5.704-5.42-7.17-5.42-7.17-4.448-3.015.324-3.015.324-3.015 4.934.326 7.523 5.052 7.523 5.052 4.367 7.496 11.404 5.378 14.235 4.074.404-3.178 1.699-5.378 3.074-6.6-10.839-1.141-22.243-5.378-22.243-24.283 0-5.378 1.94-9.778 5.014-13.2-.485-1.222-2.184-6.275.486-13.038 0 0 4.125-1.304 13.426 5.052a46.97 46.97 0 0 1 12.214-1.63c4.125 0 8.33.571 12.213 1.63 9.302-6.356 13.427-5.052 13.427-5.052 2.67 6.763.97 11.816.485 13.038 3.155 3.422 5.015 7.822 5.015 13.2 0 18.905-11.404 23.06-22.324 24.283 1.78 1.548 3.316 4.481 3.316 9.126 0 6.6-.08 11.897-.08 13.526 0 1.304.89 2.853 3.316 2.364 19.412-6.52 33.405-24.935 33.405-46.691C97.707 22 75.788 0 48.854 0z"
|
||||
fill="#fff"/>
|
||||
</svg>
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 986 B |
Binary file not shown.
Before Width: | Height: | Size: 63 KiB |
@ -14,7 +14,6 @@ import { Metadata } from "next";
|
||||
import Embed from "@/components/embed";
|
||||
import DocsFooter from "@/components/docs-footer";
|
||||
import OnThisPage from "@/components/on-this-page";
|
||||
import config from "@/config";
|
||||
|
||||
/**
|
||||
* The page to render the documentation markdown content.
|
||||
@ -31,11 +30,11 @@ const DocsPage = async ({
|
||||
);
|
||||
|
||||
// Get the content to display based on the provided slug
|
||||
const pages: DocsContentMetadata[] = await getDocsContent();
|
||||
const pages: DocsContentMetadata[] = getDocsContent();
|
||||
const decodedSlug: string = decodeURIComponent(slug || "");
|
||||
const page: DocsContentMetadata | undefined = pages.find(
|
||||
(metadata: DocsContentMetadata): boolean =>
|
||||
metadata.slug === (decodedSlug || pages[0].slug)
|
||||
metadata.slug === (decodedSlug || "intro")
|
||||
);
|
||||
if (!page) {
|
||||
notFound();
|
||||
@ -100,19 +99,15 @@ export const generateMetadata = async ({
|
||||
}): Promise<Metadata | undefined> => {
|
||||
const slug: string = (((await params).slug as string[]) || undefined)?.join(
|
||||
"/"
|
||||
);
|
||||
); // The slug of the content
|
||||
if (slug) {
|
||||
const pages: DocsContentMetadata[] = await getDocsContent();
|
||||
const decodedSlug: string = decodeURIComponent(slug || "");
|
||||
const page: DocsContentMetadata | undefined = pages.find(
|
||||
(metadata: DocsContentMetadata): boolean =>
|
||||
metadata.slug === (decodedSlug || pages[0].slug)
|
||||
);
|
||||
if (page) {
|
||||
const content: DocsContentMetadata | undefined = getDocsContent().find(
|
||||
(metadata: DocsContentMetadata): boolean => metadata.slug === slug
|
||||
); // Get the content based on the provided slug
|
||||
if (content) {
|
||||
return Embed({
|
||||
title: page.title,
|
||||
description: page.summary,
|
||||
thumbnail: config.ogApiUrl.replace("{title}", page.title),
|
||||
title: content.title,
|
||||
description: content.summary,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
@ -1,30 +0,0 @@
|
||||
import { ImageResponse } from "next/og";
|
||||
import config from "@/config";
|
||||
|
||||
export const GET = async (request: Request) => {
|
||||
const { searchParams } = new URL(request.url);
|
||||
const title: string | undefined = searchParams.has("title")
|
||||
? searchParams.get("title")?.slice(0, 100)
|
||||
: "Hello World (:";
|
||||
|
||||
return new ImageResponse(
|
||||
(
|
||||
<div tw="w-full h-full flex flex-col justify-center items-center bg-black/95 text-white">
|
||||
{/* Logo */}
|
||||
<img
|
||||
src={(config.metadata.openGraph?.images as any)[0].url}
|
||||
alt={`${config.siteName} Logo`}
|
||||
width={96}
|
||||
height={96}
|
||||
/>
|
||||
|
||||
{/* Title */}
|
||||
<h1 tw="text-5xl font-bold">{title}</h1>
|
||||
</div>
|
||||
),
|
||||
{
|
||||
width: 1200,
|
||||
height: 630,
|
||||
}
|
||||
);
|
||||
};
|
@ -1,7 +0,0 @@
|
||||
/**
|
||||
* The configuration for this app.
|
||||
*/
|
||||
import config from "@/configJson";
|
||||
import { Config } from "@/types/config";
|
||||
|
||||
export default config as Config;
|
@ -6,55 +6,64 @@ import Navbar from "@/components/navbar/navbar";
|
||||
import Sidebar from "@/components/sidebar/sidebar";
|
||||
import Footer from "@/components/footer";
|
||||
import { TooltipProvider } from "@/components/ui/tooltip";
|
||||
import { getDocsContent } from "@/lib/mdx";
|
||||
import config from "@/config";
|
||||
|
||||
/**
|
||||
* The metadata for this app.
|
||||
*/
|
||||
export const metadata: Metadata = config.metadata;
|
||||
export const viewport: Viewport = config.viewport;
|
||||
|
||||
export const dynamic = "force-dynamic";
|
||||
export const metadata: Metadata = {
|
||||
title: {
|
||||
default: "Pulse Docs",
|
||||
template: "%s • Pulse Docs",
|
||||
},
|
||||
description:
|
||||
"A lightweight service monitoring solution for tracking the availability of whatever service your heart desires!",
|
||||
openGraph: {
|
||||
images: [
|
||||
{
|
||||
url: "https://pulseapp.cc/media/logo.png",
|
||||
width: 128,
|
||||
height: 128,
|
||||
},
|
||||
],
|
||||
},
|
||||
twitter: {
|
||||
card: "summary",
|
||||
},
|
||||
};
|
||||
export const viewport: Viewport = {
|
||||
themeColor: "#A855F7",
|
||||
};
|
||||
|
||||
/**
|
||||
* The primary layout for this app.
|
||||
*/
|
||||
const RootLayout = async ({
|
||||
const RootLayout = ({
|
||||
children,
|
||||
}: Readonly<{
|
||||
children: ReactNode;
|
||||
}>): Promise<ReactElement> => {
|
||||
const pages: DocsContentMetadata[] = await getDocsContent();
|
||||
return (
|
||||
<html lang="en">
|
||||
}>): ReactElement => (
|
||||
<html lang="en">
|
||||
<ThemeProvider attribute="class" defaultTheme="dark" enableSystem>
|
||||
<body
|
||||
className="scroll-smooth antialiased"
|
||||
style={{
|
||||
background: "var(--background-gradient)",
|
||||
}}
|
||||
>
|
||||
<ThemeProvider
|
||||
attribute="class"
|
||||
defaultTheme="dark"
|
||||
enableSystem
|
||||
disableTransitionOnChange
|
||||
>
|
||||
<TooltipProvider delayDuration={100}>
|
||||
<div className="px-3 md:px-7 max-w-screen-2xl min-h-screen mx-auto flex flex-col transition-transform">
|
||||
<Navbar pages={pages} />
|
||||
<div className="pt-[4.5rem] w-full h-full flex flex-grow gap-5 sm:gap-8 transition-transform transform-gpu">
|
||||
<div className="relative hidden xs:flex">
|
||||
<Sidebar pages={pages} />
|
||||
</div>
|
||||
{children}
|
||||
<TooltipProvider delayDuration={100}>
|
||||
<div className="px-3 md:px-7 max-w-screen-2xl min-h-screen mx-auto flex flex-col transition-all">
|
||||
<Navbar />
|
||||
<div className="pt-[4.5rem] w-full h-full flex flex-grow gap-5">
|
||||
<div className="relative hidden xs:flex">
|
||||
<Sidebar />
|
||||
</div>
|
||||
{children}
|
||||
</div>
|
||||
<Footer />
|
||||
</TooltipProvider>
|
||||
</ThemeProvider>
|
||||
</div>
|
||||
<Footer />
|
||||
</TooltipProvider>
|
||||
</body>
|
||||
</html>
|
||||
);
|
||||
};
|
||||
</ThemeProvider>
|
||||
</html>
|
||||
);
|
||||
export default RootLayout;
|
||||
|
@ -1,33 +0,0 @@
|
||||
import { ReactElement } from "react";
|
||||
import Image from "next/image";
|
||||
|
||||
/**
|
||||
* The not found page.
|
||||
*
|
||||
* @return the page jsx
|
||||
*/
|
||||
const NotFoundPage = (): ReactElement => (
|
||||
<main className="w-full pt-[25vh] min-h-screen flex justify-center select-none pointer-events-none">
|
||||
<div className="h-fit flex gap-5 sm:gap-10 items-center transition-all transform-gpu">
|
||||
{/* Image */}
|
||||
<div className="relative w-24 h-24 xs:w-20 xs:h-20 sm:w-44 sm:h-44">
|
||||
<Image
|
||||
src="/media/mike.png"
|
||||
alt="Mike Wazowski"
|
||||
fill
|
||||
draggable={false}
|
||||
/>
|
||||
</div>
|
||||
|
||||
{/* Message */}
|
||||
<div className="flex flex-col gap-0.5">
|
||||
<h1 className="text-3xl font-bold">Wrong Door!</h1>
|
||||
<p className="max-w-72 sm:text-lg opacity-75">
|
||||
The documentation page you were looking for could not be
|
||||
found.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
);
|
||||
export default NotFoundPage;
|
@ -20,13 +20,13 @@ body {
|
||||
--card-foreground: 240 10% 3.9%;
|
||||
--popover: 0 0% 100%;
|
||||
--popover-foreground: 240 10% 3.9%;
|
||||
--primary: 271 91% 65%;
|
||||
--primary: 240 5.9% 10%;
|
||||
--primary-foreground: 0 0% 98%;
|
||||
--secondary: 240 4.8% 95.9%;
|
||||
--secondary-foreground: 240 5.9% 10%;
|
||||
--muted: 240 4.8% 95.9%;
|
||||
--muted-foreground: 240 3.8% 46.1%;
|
||||
--accent: 0 0% 90%;
|
||||
--accent: 240 4.8% 95.9%;
|
||||
--accent-foreground: 240 5.9% 10%;
|
||||
--destructive: 0 84.2% 60.2%;
|
||||
--destructive-foreground: 0 0% 98%;
|
||||
|
@ -1,104 +0,0 @@
|
||||
import type { Metadata, Viewport } from "next";
|
||||
|
||||
export type Config = {
|
||||
/**
|
||||
* The name of this app.
|
||||
*/
|
||||
siteName: string;
|
||||
|
||||
/**
|
||||
* The URL to use for generating OG images.
|
||||
*/
|
||||
ogApiUrl: string;
|
||||
|
||||
/**
|
||||
* The metadata for this app.
|
||||
*/
|
||||
metadata: Metadata;
|
||||
|
||||
/**
|
||||
* The viewport for this app.
|
||||
*/
|
||||
viewport: Viewport;
|
||||
|
||||
/**
|
||||
* The source to get the content from.
|
||||
* This can either be a local source, or
|
||||
* a remote Git repository.
|
||||
*/
|
||||
contentSource: string;
|
||||
|
||||
/**
|
||||
* The URL to link to for editing content of a page.
|
||||
*/
|
||||
contentEditUrl: string;
|
||||
|
||||
/**
|
||||
* Social links for this app.
|
||||
*/
|
||||
socialLinks: SocialLinkType[];
|
||||
|
||||
/**
|
||||
* Configuration for the footer.
|
||||
*/
|
||||
footer: {
|
||||
/**
|
||||
* The URL to link to when the branding is clicked.
|
||||
*/
|
||||
homeUrl: string;
|
||||
|
||||
/**
|
||||
* Links for the footer.
|
||||
*/
|
||||
links: {
|
||||
[category: string]: FooterLink[];
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
export type SocialLinkType = {
|
||||
/**
|
||||
* The name of this social link.
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* The tooltip for this social link.
|
||||
*/
|
||||
tooltip: string;
|
||||
|
||||
/**
|
||||
* The logo for this social link.
|
||||
* This can either be an image URL, or
|
||||
* the name of an icon from <a href="https://lucide.dev/icons">Lucide Icons</a>
|
||||
*/
|
||||
logo: string;
|
||||
|
||||
/**
|
||||
* The href for this social link.
|
||||
*/
|
||||
href: string;
|
||||
|
||||
/**
|
||||
* Whether to show this social link in the navbar.
|
||||
*/
|
||||
navbar: boolean;
|
||||
};
|
||||
|
||||
export type FooterLink = {
|
||||
/**
|
||||
* The name of this link.
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* The href for this link.
|
||||
*/
|
||||
href: string;
|
||||
|
||||
/**
|
||||
* The optional name to show
|
||||
* when the screen size is small.
|
||||
*/
|
||||
shortName?: string;
|
||||
};
|
@ -8,9 +8,9 @@ type DocsContentMetadata = MDXMetadata & {
|
||||
title: string;
|
||||
|
||||
/**
|
||||
* The date this content was updated.
|
||||
* The date this content was published.
|
||||
*/
|
||||
updated: string;
|
||||
published: string;
|
||||
|
||||
/**
|
||||
* The summary of this content.
|
||||
|
@ -17,22 +17,21 @@ const DocsFooter = ({
|
||||
|
||||
const current: number = pages.findIndex(
|
||||
(page: DocsContentMetadata) =>
|
||||
(path === "/" && page.slug === pages[0].slug) ||
|
||||
path === `/${page.slug}`
|
||||
(path === "/" && page.slug === "intro") || path === `/${page.slug}`
|
||||
);
|
||||
const previous: DocsContentMetadata | undefined =
|
||||
current > 0 ? pages[current - 1] : undefined;
|
||||
const next: DocsContentMetadata | undefined =
|
||||
current < pages.length - 1 ? pages[current + 1] : undefined;
|
||||
|
||||
const [updatedDate, setUpdatedDate] = useState<string | null>(
|
||||
DateTime.fromISO(pages[current]?.updated).toRelative()
|
||||
const [publicationDate, setPublicationDate] = useState<string | null>(
|
||||
DateTime.fromISO(pages[current]?.published).toRelative()
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
const interval = setInterval(() => {
|
||||
setUpdatedDate(
|
||||
DateTime.fromISO(pages[current]?.updated).toRelative()
|
||||
setPublicationDate(
|
||||
DateTime.fromISO(pages[current]?.published).toRelative()
|
||||
);
|
||||
}, 1000);
|
||||
return () => clearInterval(interval);
|
||||
@ -40,22 +39,22 @@ const DocsFooter = ({
|
||||
|
||||
return (
|
||||
<footer className="xs:mx-5 sm:mx-10 my-2 flex flex-col select-none transition-all transform-gpu">
|
||||
{/* updated Date */}
|
||||
{/* Publish Date */}
|
||||
<div className="ml-auto pt-4">
|
||||
<SimpleTooltip
|
||||
content={`Last updated on ${DateTime.fromISO(
|
||||
pages[current]?.updated
|
||||
).toLocaleString(DateTime.DATETIME_MED)}`}
|
||||
content={DateTime.fromISO(
|
||||
pages[current]?.published
|
||||
).toLocaleString(DateTime.DATETIME_MED)}
|
||||
>
|
||||
<span className="text-xs sm:text-sm opacity-75 transition-all transform-gpu">
|
||||
Updated {updatedDate}
|
||||
Published {publicationDate}
|
||||
</span>
|
||||
</SimpleTooltip>
|
||||
</div>
|
||||
|
||||
{/* Pages */}
|
||||
{previous || next ? (
|
||||
<Separator className="my-4 dark:bg-separator-gradient" />
|
||||
<Separator className="my-4 bg-separator-gradient" />
|
||||
) : undefined}
|
||||
<div className="flex justify-between text-xs sm:text-base">
|
||||
{/* Previous */}
|
||||
|
@ -13,11 +13,6 @@ type EmbedProps = {
|
||||
* The description of the embed.
|
||||
*/
|
||||
description: string;
|
||||
|
||||
/**
|
||||
* The optional thumbnail image of the embed.
|
||||
*/
|
||||
thumbnail?: string | undefined;
|
||||
};
|
||||
|
||||
/**
|
||||
@ -26,25 +21,13 @@ type EmbedProps = {
|
||||
* @param props the embed props
|
||||
* @returns the embed jsx
|
||||
*/
|
||||
const Embed = ({ title, description, thumbnail }: EmbedProps): Metadata => {
|
||||
const Embed = ({ title, description }: EmbedProps): Metadata => {
|
||||
return {
|
||||
title: title,
|
||||
openGraph: {
|
||||
title: `${title}`,
|
||||
description: description,
|
||||
...(thumbnail && {
|
||||
images: [
|
||||
{
|
||||
url: thumbnail,
|
||||
},
|
||||
],
|
||||
}),
|
||||
},
|
||||
...(thumbnail && {
|
||||
twitter: {
|
||||
card: "summary_large_image",
|
||||
},
|
||||
}),
|
||||
};
|
||||
};
|
||||
export default Embed;
|
||||
|
@ -5,10 +5,44 @@ import AnimatedGridPattern from "@/components/ui/animated-grid-pattern";
|
||||
import Link from "next/link";
|
||||
import Image from "next/image";
|
||||
import { cn } from "@/lib/utils";
|
||||
import { ExternalLink } from "lucide-react";
|
||||
import SocialLink from "@/components/social-link";
|
||||
import config from "@/config";
|
||||
import { SocialLinkType } from "@/types/config";
|
||||
import { ExternalLink, Mail } from "lucide-react";
|
||||
|
||||
const links = {
|
||||
Resources: [
|
||||
{
|
||||
name: "Support",
|
||||
href: "https://support.pulseapp.cc",
|
||||
},
|
||||
{
|
||||
name: "Jobs",
|
||||
href: "https://jobs.pulseapp.cc",
|
||||
},
|
||||
{
|
||||
name: "Developers",
|
||||
shortName: "Devs",
|
||||
href: "https://dev.pulseapp.cc",
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
name: "System Status",
|
||||
shortName: "Status",
|
||||
href: "https://status.pulseapp.cc",
|
||||
external: true,
|
||||
},
|
||||
],
|
||||
Legal: [
|
||||
{
|
||||
name: "Terms & Conditions",
|
||||
shortName: "Terms",
|
||||
href: "/legal/terms",
|
||||
},
|
||||
{
|
||||
name: "Privacy Policy",
|
||||
shortName: "Privacy",
|
||||
href: "/legal/privacy",
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
const Footer = (): ReactElement => (
|
||||
<footer className="relative mt-3 h-[19.5rem] md:h-[17rem] flex justify-center border-t border-zinc-700/75 overflow-hidden select-none">
|
||||
@ -20,34 +54,40 @@ const Footer = (): ReactElement => (
|
||||
|
||||
{/* Socials */}
|
||||
<div className="pl-1 flex gap-2.5 items-center z-50">
|
||||
{config.socialLinks.map((link: SocialLinkType) => (
|
||||
<SocialLink
|
||||
key={link.name}
|
||||
className="w-5 h-5"
|
||||
{...link}
|
||||
/>
|
||||
))}
|
||||
<SocialLink
|
||||
name="GitHub"
|
||||
logo="github.svg"
|
||||
href="https://github.com/PulseAppCC"
|
||||
/>
|
||||
<SocialLink
|
||||
name="Discord"
|
||||
logo="discord.svg"
|
||||
href="https://discord.pulseapp.cc"
|
||||
/>
|
||||
<SocialLink
|
||||
name="Email"
|
||||
logo={<Mail className="opacity-95 w-6 h-6" />}
|
||||
href="mailto:support@pulseapp.cc"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Links */}
|
||||
<div className="flex gap-7 md:gap-12 transition-all transform-gpu">
|
||||
{Object.entries(config.footer.links).map(
|
||||
([title, links]) => (
|
||||
<LinkCategory key={title} title={title}>
|
||||
{links.map((link) => (
|
||||
<FooterLink key={link.name} {...link} />
|
||||
))}
|
||||
</LinkCategory>
|
||||
)
|
||||
)}
|
||||
{Object.entries(links).map(([title, links]) => (
|
||||
<LinkCategory key={title} title={title}>
|
||||
{links.map((link) => (
|
||||
<FooterLink key={link.name} {...link} />
|
||||
))}
|
||||
</LinkCategory>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Copyright */}
|
||||
<p className="absolute inset-x-0 bottom-3.5 flex text-sm text-center justify-center opacity-60">
|
||||
Copyright © {new Date().getFullYear()} {config.siteName}.
|
||||
All rights reserved.
|
||||
Copyright © {new Date().getFullYear()} Pulse App. All
|
||||
rights reserved.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@ -65,17 +105,46 @@ const Footer = (): ReactElement => (
|
||||
const Branding = () => (
|
||||
<Link
|
||||
className="flex gap-3 items-center hover:opacity-75 transition-all transform-gpu"
|
||||
href={config.footer.homeUrl}
|
||||
href="https://pulseapp.cc"
|
||||
draggable={false}
|
||||
>
|
||||
<Image
|
||||
src="/media/logo.png"
|
||||
alt={`${config.siteName} Logo`}
|
||||
alt="Pulse App Logo"
|
||||
width={40}
|
||||
height={40}
|
||||
draggable={false}
|
||||
/>
|
||||
<h1 className="text-xl font-bold">{config.siteName}</h1>
|
||||
<h1 className="text-xl font-bold">Pulse App</h1>
|
||||
</Link>
|
||||
);
|
||||
|
||||
const SocialLink = ({
|
||||
name,
|
||||
logo,
|
||||
href,
|
||||
}: {
|
||||
name: string;
|
||||
logo: string | ReactElement;
|
||||
href: string;
|
||||
}) => (
|
||||
<Link
|
||||
className="hover:opacity-75 transition-all transform-gpu"
|
||||
href={href}
|
||||
target="_blank"
|
||||
draggable={false}
|
||||
>
|
||||
{typeof logo === "string" ? (
|
||||
<Image
|
||||
src={`/media/${logo}`}
|
||||
alt={`${name}'s Logo`}
|
||||
width={20}
|
||||
height={20}
|
||||
draggable={false}
|
||||
/>
|
||||
) : (
|
||||
logo
|
||||
)}
|
||||
</Link>
|
||||
);
|
||||
|
||||
|
@ -13,7 +13,6 @@ import {
|
||||
import Link from "next/link";
|
||||
import { capitalizeWords } from "@/lib/string";
|
||||
import ImageViewer from "@/components/image-viewer";
|
||||
import Image from "next/image";
|
||||
|
||||
const blockquoteStyles: { [key: string]: any } = {
|
||||
NOTE: {
|
||||
@ -97,13 +96,10 @@ const components = {
|
||||
// Media
|
||||
img: ({ src, alt }: { src: string; alt: string }): ReactElement => (
|
||||
<ImageViewer className="m-2 my-2.5">
|
||||
<Image
|
||||
<img
|
||||
className="ring-1 ring-muted/45 rounded-2xl select-none"
|
||||
src={src}
|
||||
alt={alt}
|
||||
width={1920}
|
||||
height={1080}
|
||||
unoptimized
|
||||
draggable={false}
|
||||
/>
|
||||
</ImageViewer>
|
||||
|
@ -1,55 +1,76 @@
|
||||
"use client";
|
||||
|
||||
import { ReactElement } from "react";
|
||||
import Link from "next/link";
|
||||
import Image from "next/image";
|
||||
import QuickSearchDialog from "@/components/navbar/search-dialog";
|
||||
import { getDocsContent } from "@/lib/mdx";
|
||||
import Sidebar from "@/components/sidebar/sidebar";
|
||||
import SocialLink from "@/components/social-link";
|
||||
import config from "@/config";
|
||||
import { SocialLinkType } from "@/types/config";
|
||||
|
||||
const Navbar = ({ pages }: { pages: DocsContentMetadata[] }): ReactElement => (
|
||||
<nav className="fixed left-0 inset-x-0 bg-white/95 dark:bg-white/[0.007] backdrop-saturate-100 backdrop-blur-xl border-b z-50">
|
||||
<div className="px-3 md:px-7 max-w-screen-2xl mx-auto py-4 flex justify-between items-center transition-all transform-gpu">
|
||||
{/* Branding */}
|
||||
<Link
|
||||
className="flex gap-1 items-end hover:opacity-75 transition-all transform-gpu select-none"
|
||||
href="/"
|
||||
draggable={false}
|
||||
>
|
||||
<h1 className="text-lg font-semibold">docs.</h1>
|
||||
<Image
|
||||
src="/media/logo.png"
|
||||
alt={`${config.siteName} Logo`}
|
||||
width={36}
|
||||
height={36}
|
||||
const Navbar = (): ReactElement => {
|
||||
const pages: DocsContentMetadata[] = getDocsContent();
|
||||
return (
|
||||
<nav className="fixed left-0 inset-x-0 bg-white/[0.007] backdrop-saturate-100 backdrop-blur-xl border-b z-50">
|
||||
<div className="px-3 md:px-7 max-w-screen-2xl mx-auto py-4 flex justify-between items-center transition-all transform-gpu">
|
||||
{/* Branding */}
|
||||
<Link
|
||||
className="flex gap-1 items-end hover:opacity-75 transition-all transform-gpu select-none"
|
||||
href="/"
|
||||
draggable={false}
|
||||
/>
|
||||
</Link>
|
||||
>
|
||||
<h1 className="text-lg font-semibold">docs.</h1>
|
||||
<Image
|
||||
src="/media/logo.png"
|
||||
alt="Pulse App Logo"
|
||||
width={36}
|
||||
height={36}
|
||||
draggable={false}
|
||||
/>
|
||||
</Link>
|
||||
|
||||
{/* Right */}
|
||||
<div className="flex gap-5 sm:gap-7 items-center transition-all transform-gpu">
|
||||
{/* Search */}
|
||||
<div className="hidden xs:flex">
|
||||
<QuickSearchDialog pages={pages} bindKeybind />
|
||||
</div>
|
||||
{/* Right */}
|
||||
<div className="flex gap-5 sm:gap-7 items-center transition-all transform-gpu">
|
||||
{/* Search */}
|
||||
<div className="hidden xs:flex">
|
||||
<QuickSearchDialog pages={pages} bindKeybind />
|
||||
</div>
|
||||
|
||||
{/* Social */}
|
||||
<div className="flex gap-5 items-center">
|
||||
{config.socialLinks
|
||||
.filter((link: SocialLinkType) => link.navbar)
|
||||
.map((link: SocialLinkType) => (
|
||||
<SocialLink key={link.name} {...link} />
|
||||
))}
|
||||
</div>
|
||||
{/* Social */}
|
||||
<div className="flex gap-5 items-center">
|
||||
<SocialLink
|
||||
name="GitHub"
|
||||
link="https://github.com/PulseAppCC"
|
||||
icon="/media/github.svg"
|
||||
/>
|
||||
<SocialLink
|
||||
name="Discord"
|
||||
link="https://discord.pulseapp.cc"
|
||||
icon="/media/discord.svg"
|
||||
/>
|
||||
</div>
|
||||
|
||||
{/* Mobile Sidebar */}
|
||||
<div className="flex xs:hidden">
|
||||
<Sidebar pages={pages} />
|
||||
{/* Mobile Sidebar */}
|
||||
<div className="flex xs:hidden">
|
||||
<Sidebar />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</nav>
|
||||
);
|
||||
};
|
||||
|
||||
const SocialLink = ({
|
||||
name,
|
||||
link,
|
||||
icon,
|
||||
}: {
|
||||
name: string;
|
||||
link: string;
|
||||
icon: string;
|
||||
}): ReactElement => (
|
||||
<div className="relative w-6 h-6 hover:opacity-75 transition-all transform-gpu select-none">
|
||||
<Link href={link} target="_blank" draggable={false}>
|
||||
<Image src={icon} alt={`${name} Logo`} fill draggable={false} />
|
||||
</Link>
|
||||
</div>
|
||||
);
|
||||
|
||||
export default Navbar;
|
||||
|
@ -52,7 +52,7 @@ const QuickSearchDialog = ({
|
||||
className="cursor-pointer hover:opacity-85 transition-all transform-gpu select-none"
|
||||
onClick={() => setOpen(true)}
|
||||
>
|
||||
<div className="absolute top-[0.55rem] left-3 z-10">
|
||||
<div className="absolute top-2.5 left-3 z-10">
|
||||
<Search className="w-[1.15rem] h-[1.15rem]" />
|
||||
</div>
|
||||
|
||||
@ -114,4 +114,5 @@ const QuickSearchDialog = ({
|
||||
</>
|
||||
);
|
||||
};
|
||||
|
||||
export default QuickSearchDialog;
|
||||
|
@ -8,8 +8,6 @@ import { motion, useInView } from "framer-motion";
|
||||
import { Separator } from "@/components/ui/separator";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { AlignLeftIcon, ArrowUpFromDot, MoveRight } from "lucide-react";
|
||||
import config from "@/config";
|
||||
import { Skeleton } from "@/components/ui/skeleton";
|
||||
|
||||
type Header = {
|
||||
id: string;
|
||||
@ -18,7 +16,6 @@ type Header = {
|
||||
};
|
||||
|
||||
const OnThisPage = ({ page }: { page: DocsContentMetadata }): ReactElement => {
|
||||
const [loading, setLoading] = useState<boolean>(true);
|
||||
const [headers, setHeaders] = useState<Header[]>([]);
|
||||
const [activeHeader, setActiveHeader] = useState<string | undefined>(
|
||||
undefined
|
||||
@ -36,7 +33,7 @@ const OnThisPage = ({ page }: { page: DocsContentMetadata }): ReactElement => {
|
||||
let match;
|
||||
while ((match = headerRegex.exec(page.content)) !== null) {
|
||||
const level: number = match[1].length; // The number of # symbols determines the header level
|
||||
const text: string = match[2].trim().replace(/<[^>]*>/g, "");
|
||||
const text: string = match[2].trim();
|
||||
const id: string = text
|
||||
.toLowerCase()
|
||||
.replace(/\s+/g, "-")
|
||||
@ -46,7 +43,6 @@ const OnThisPage = ({ page }: { page: DocsContentMetadata }): ReactElement => {
|
||||
}
|
||||
|
||||
setHeaders(extractedHeaders);
|
||||
setLoading(false);
|
||||
}, [page.content]);
|
||||
|
||||
useEffect(() => {
|
||||
@ -83,8 +79,8 @@ const OnThisPage = ({ page }: { page: DocsContentMetadata }): ReactElement => {
|
||||
return (
|
||||
<motion.div
|
||||
ref={ref}
|
||||
className="sticky top-[7.5rem] w-44 max-h-[calc(100vh-3.5rem)] flex flex-col gap-2 text-sm select-none"
|
||||
initial={{ opacity: 1 }}
|
||||
className="sticky top-[7rem] w-44 max-h-[calc(100vh-3.5rem)] flex flex-col gap-2 text-sm select-none"
|
||||
initial={{ opacity: 0 }}
|
||||
animate={{ opacity: inView ? 1 : 0 }}
|
||||
transition={{ duration: 0.2 }}
|
||||
>
|
||||
@ -96,50 +92,42 @@ const OnThisPage = ({ page }: { page: DocsContentMetadata }): ReactElement => {
|
||||
|
||||
{/* Headers */}
|
||||
<ul className="relative">
|
||||
{loading ? (
|
||||
<Skeleton className="w-full h-5 bg-accent rounded-lg" />
|
||||
) : headers.length === 0 ? (
|
||||
<span className="opacity-75">Nothing ):</span>
|
||||
) : (
|
||||
headers.map((header: Header) => (
|
||||
<li
|
||||
key={header.id}
|
||||
className={cn(
|
||||
"hover:opacity-80 transition-all transform-gpu relative",
|
||||
activeHeader === header.id
|
||||
? "font-semibold text-primary"
|
||||
: "opacity-65"
|
||||
)}
|
||||
style={{
|
||||
paddingLeft: `${(header.level - 1) * 16}px`,
|
||||
}}
|
||||
>
|
||||
{/* Indentation */}
|
||||
{header.level > 1 && (
|
||||
<div
|
||||
className="absolute left-0 top-0 bottom-0 border-l border-accent"
|
||||
style={{
|
||||
left: `${(header.level - 2) * 16 + 4}px`,
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
{headers.map((header: Header) => (
|
||||
<li
|
||||
key={header.id}
|
||||
className={cn(
|
||||
"hover:opacity-80 transition-all transform-gpu relative",
|
||||
activeHeader === header.id
|
||||
? "font-semibold text-primary"
|
||||
: "opacity-65"
|
||||
)}
|
||||
style={{ paddingLeft: `${(header.level - 1) * 16}px` }}
|
||||
>
|
||||
{/* Indentation */}
|
||||
{header.level > 1 && (
|
||||
<div
|
||||
className="absolute left-0 top-0 bottom-0 border-l border-muted"
|
||||
style={{
|
||||
left: `${(header.level - 2) * 16 + 4}px`,
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
|
||||
{/* Header */}
|
||||
<Link
|
||||
href={`#${header.id}`}
|
||||
draggable={false}
|
||||
className="block py-1"
|
||||
>
|
||||
{truncateText(header.text, 20)}
|
||||
</Link>
|
||||
</li>
|
||||
))
|
||||
)}
|
||||
{/* Header */}
|
||||
<Link
|
||||
href={`#${header.id}`}
|
||||
draggable={false}
|
||||
className="block py-1"
|
||||
>
|
||||
{truncateText(header.text, 24)}
|
||||
</Link>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
|
||||
{/* Footer */}
|
||||
<div>
|
||||
<Separator className="mt-1 mb-3.5 dark:bg-separator-gradient" />
|
||||
<Separator className="mt-1 mb-3.5 bg-separator-gradient" />
|
||||
<Footer page={page} />
|
||||
</div>
|
||||
</motion.div>
|
||||
@ -160,9 +148,7 @@ const Footer = ({ page }: { page: DocsContentMetadata }): ReactElement => {
|
||||
{/* Edit on Git */}
|
||||
<Link
|
||||
className="flex gap-1.5 items-center text-xs hover:opacity-75 transition-all transform-gpu group"
|
||||
href={config.contentEditUrl
|
||||
.replace("{slug}", page.slug as string)
|
||||
.replace("{ext}", page.extension as string)}
|
||||
href={`https://git.rainnny.club/PulseApp/docs/src/branch/master/docs/${page.slug}${page.extension}`}
|
||||
target="_blank"
|
||||
draggable={false}
|
||||
>
|
||||
|
@ -22,7 +22,7 @@ const SidebarLinks = ({
|
||||
return (
|
||||
<div className="flex flex-col gap-1">
|
||||
{Object.values(tree).map((node: TreeNode) => (
|
||||
<CategoryItem key={node.slug} pages={pages} node={node} />
|
||||
<CategoryItem key={node.slug} node={node} />
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
@ -36,30 +36,27 @@ type TreeNode = {
|
||||
};
|
||||
|
||||
const CategoryItem = ({
|
||||
pages,
|
||||
node,
|
||||
depth = 0,
|
||||
isLast = true,
|
||||
}: {
|
||||
pages: DocsContentMetadata[];
|
||||
node: TreeNode;
|
||||
depth?: number;
|
||||
isLast?: boolean;
|
||||
}) => {
|
||||
const path = decodeURIComponent(usePathname());
|
||||
const active =
|
||||
(path === "/" && node.slug === pages[0].slug) ||
|
||||
path === `/${node.slug}`;
|
||||
(path === "/" && node.slug === "intro") || path === `/${node.slug}`;
|
||||
const [isOpen, setIsOpen] = useState(true);
|
||||
const hasChildren = Object.keys(node.children).length > 0;
|
||||
|
||||
return (
|
||||
<div className={cn(`relative select-none`, depth > 0 && "ml-3")}>
|
||||
<div className={cn(`relative select-none`, depth > 0 && "ml-4")}>
|
||||
{/* Indentation */}
|
||||
{depth > 0 && (
|
||||
<div
|
||||
className={cn(
|
||||
"absolute left-0 bottom-0 border-l border-accent",
|
||||
"absolute left-0 bottom-0 border-l border-muted",
|
||||
isLast ? "h-[32px]" : "h-[100%]",
|
||||
active && "border-primary"
|
||||
)}
|
||||
@ -75,13 +72,10 @@ const CategoryItem = ({
|
||||
>
|
||||
<Button
|
||||
className={cn(
|
||||
`relative w-full px-1.5 h-8 justify-between hover:bg-accent/35 hover:opacity-90`,
|
||||
node.isFolder
|
||||
? "mb-0.5 text-sm font-semibold"
|
||||
: "lg:text-base",
|
||||
`relative w-full px-1.5 h-8 lg:text-base justify-between hover:bg-accent/20`,
|
||||
depth > 0 && "pl-4",
|
||||
active &&
|
||||
"text-primary/95 font-semibold hover:text-primary"
|
||||
"text-primary/95 font-bold hover:text-primary"
|
||||
)}
|
||||
variant="ghost"
|
||||
>
|
||||
@ -124,7 +118,6 @@ const CategoryItem = ({
|
||||
(child, index, array) => (
|
||||
<CategoryItem
|
||||
key={child.slug}
|
||||
pages={pages}
|
||||
node={child}
|
||||
depth={depth + 1}
|
||||
isLast={index === array.length - 1}
|
||||
|
@ -1,12 +1,13 @@
|
||||
import { ReactElement } from "react";
|
||||
import { Separator } from "@/components/ui/separator";
|
||||
import { getDocsContent } from "@/lib/mdx";
|
||||
import SidebarLinks from "@/components/sidebar/sidebar-links";
|
||||
import ThemeSwitcher from "@/components/theme-switcher";
|
||||
import { Sheet, SheetContent, SheetTrigger } from "@/components/ui/sheet";
|
||||
import QuickSearchDialog from "@/components/navbar/search-dialog";
|
||||
import { AlignRightIcon } from "lucide-react";
|
||||
import { Separator } from "@/components/ui/separator";
|
||||
import ThemeSwitcher from "@/components/theme-switcher";
|
||||
|
||||
const Sidebar = ({ pages }: { pages: DocsContentMetadata[] }): ReactElement => (
|
||||
const Sidebar = (): ReactElement => (
|
||||
<>
|
||||
{/* Mobile */}
|
||||
<div className="xs:hidden">
|
||||
@ -15,38 +16,37 @@ const Sidebar = ({ pages }: { pages: DocsContentMetadata[] }): ReactElement => (
|
||||
<AlignRightIcon className="w-6 h-6" />
|
||||
</SheetTrigger>
|
||||
<SheetContent className="h-full px-5 pt-11" side="right">
|
||||
<SidebarContent pages={pages} />
|
||||
<SidebarContent />
|
||||
</SheetContent>
|
||||
</Sheet>
|
||||
</div>
|
||||
|
||||
{/* Desktop */}
|
||||
<div className="hidden xs:flex sticky top-[4.5rem] max-h-[calc(100vh-4.5rem)] min-w-32 w-40 lg:w-52 py-5 pb-3 flex-col justify-between transition-all transform-gpu overflow-y-auto">
|
||||
<SidebarContent pages={pages} />
|
||||
<div className="hidden xs:flex sticky top-[4.5rem] max-h-[calc(100vh-3.5rem)] overflow-y-auto min-w-32 w-40 lg:w-52 py-5 flex-col justify-between transition-all transform-gpu">
|
||||
<SidebarContent />
|
||||
</div>
|
||||
</>
|
||||
);
|
||||
|
||||
const SidebarContent = ({
|
||||
pages,
|
||||
}: {
|
||||
pages: DocsContentMetadata[];
|
||||
}): ReactElement => (
|
||||
<div className="h-full flex flex-col justify-between">
|
||||
{/* Top */}
|
||||
<div className="flex flex-col">
|
||||
<div className="xs:hidden pb-3">
|
||||
<QuickSearchDialog pages={pages} />
|
||||
const SidebarContent = (): ReactElement => {
|
||||
const pages: DocsContentMetadata[] = getDocsContent();
|
||||
return (
|
||||
<div className="h-full flex flex-col justify-between">
|
||||
{/* Top */}
|
||||
<div className="flex flex-col">
|
||||
<div className="xs:hidden pb-3">
|
||||
<QuickSearchDialog pages={pages} />
|
||||
</div>
|
||||
<SidebarLinks pages={pages} />
|
||||
</div>
|
||||
<SidebarLinks pages={pages} />
|
||||
</div>
|
||||
|
||||
{/* Theme Switcher */}
|
||||
<div className="flex flex-col items-center">
|
||||
<Separator className="mb-3 dark:bg-separator-gradient" />
|
||||
<ThemeSwitcher />
|
||||
{/* Theme Switcher */}
|
||||
<div className="flex flex-col items-center">
|
||||
<Separator className="mb-3 bg-separator-gradient" />
|
||||
<ThemeSwitcher />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
);
|
||||
};
|
||||
|
||||
export default Sidebar;
|
||||
|
@ -39,10 +39,7 @@ const SimpleTooltip = ({
|
||||
}: SimpleTooltipProps): ReactElement => (
|
||||
<Tooltip>
|
||||
<TooltipTrigger asChild>{children}</TooltipTrigger>
|
||||
<TooltipContent
|
||||
className="bg-accent text-accent-foreground"
|
||||
side={side}
|
||||
>
|
||||
<TooltipContent className="bg-muted text-white" side={side}>
|
||||
{content}
|
||||
</TooltipContent>
|
||||
</Tooltip>
|
||||
|
@ -1,46 +0,0 @@
|
||||
import SimpleTooltip from "@/components/simple-tooltip";
|
||||
import Link from "next/link";
|
||||
import Image from "next/image";
|
||||
import { cn } from "@/lib/utils";
|
||||
import Icon from "@/components/ui/icon";
|
||||
import { icons } from "lucide-react";
|
||||
import { SocialLinkType } from "@/types/config";
|
||||
|
||||
type SocialLinkProps = SocialLinkType & {
|
||||
className?: string | undefined;
|
||||
};
|
||||
|
||||
const SocialLink = ({
|
||||
className,
|
||||
name,
|
||||
tooltip,
|
||||
logo,
|
||||
href,
|
||||
}: SocialLinkProps) => (
|
||||
<SimpleTooltip content={tooltip}>
|
||||
<Link
|
||||
className={cn(
|
||||
"w-6 h-6 hover:opacity-75 transition-all transform-gpu select-none",
|
||||
className
|
||||
)}
|
||||
href={href}
|
||||
target="_blank"
|
||||
draggable={false}
|
||||
>
|
||||
{logo.startsWith("./") ? (
|
||||
<Image
|
||||
src={`/media/${logo.substring(2)}`}
|
||||
alt={`${name}'s Logo`}
|
||||
fill
|
||||
draggable={false}
|
||||
/>
|
||||
) : (
|
||||
<Icon
|
||||
className="opacity-95 w-full h-full"
|
||||
name={logo as keyof typeof icons}
|
||||
/>
|
||||
)}
|
||||
</Link>
|
||||
</SimpleTooltip>
|
||||
);
|
||||
export default SocialLink;
|
@ -10,9 +10,9 @@ import SimpleTooltip from "@/components/simple-tooltip";
|
||||
import { capitalizeWords } from "@/lib/string";
|
||||
|
||||
const themes = {
|
||||
system: <Monitor className="w-4 h-4" />,
|
||||
dark: <MoonStar className="w-4 h-4" />,
|
||||
light: <Sun className="w-4 h-4" />,
|
||||
system: <Monitor className="w-4 h-4" />,
|
||||
};
|
||||
|
||||
/**
|
||||
@ -29,7 +29,7 @@ const ThemeSwitcher = (): ReactElement => {
|
||||
}, []);
|
||||
|
||||
return (
|
||||
<div className="w-fit p-1 flex gap-1.5 bg-gray-600/5 dark:bg-black/30 ring-1 light:ring-inset ring-gray-600/5 dark:ring-white/5 rounded-full">
|
||||
<div className="w-fit p-1 flex gap-1.5 bg-black/30 ring-1 ring-white/5 rounded-full">
|
||||
{Object.entries(themes).map(([theme, icon]) => {
|
||||
const active: boolean = mounted && theme === activeTheme;
|
||||
return (
|
||||
@ -41,7 +41,7 @@ const ThemeSwitcher = (): ReactElement => {
|
||||
className={cn(
|
||||
"p-1 h-6 opacity-80 rounded-full",
|
||||
active &&
|
||||
"ring-1 bg-white dark:bg-zinc-900 ring-gray-900/10 dark:ring-white/15 hover:bg-white hover:dark:bg-zinc-900 opacity-100"
|
||||
"ring-1 bg-zinc-900 ring-white/15 opacity-100"
|
||||
)}
|
||||
variant="ghost"
|
||||
onClick={() => setTheme(theme)}
|
||||
@ -54,4 +54,5 @@ const ThemeSwitcher = (): ReactElement => {
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
export default ThemeSwitcher;
|
||||
|
@ -83,16 +83,14 @@ export function GridPattern({
|
||||
});
|
||||
}
|
||||
});
|
||||
let current = undefined;
|
||||
|
||||
if (containerRef.current) {
|
||||
resizeObserver.observe(containerRef.current);
|
||||
current = containerRef.current;
|
||||
}
|
||||
|
||||
return () => {
|
||||
if (current) {
|
||||
resizeObserver.unobserve(current);
|
||||
if (containerRef.current) {
|
||||
resizeObserver.unobserve(containerRef.current);
|
||||
}
|
||||
};
|
||||
}, [containerRef]);
|
||||
|
@ -1,10 +0,0 @@
|
||||
import { icons, LucideProps } from "lucide-react";
|
||||
|
||||
interface IconProps extends LucideProps {
|
||||
name: keyof typeof icons;
|
||||
}
|
||||
|
||||
export default function Icon({ name, color, size, ...props }: IconProps) {
|
||||
const LucideIcon = icons[name];
|
||||
return <LucideIcon color={color} size={size} {...props} />;
|
||||
}
|
@ -1,15 +0,0 @@
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Skeleton({
|
||||
className,
|
||||
...props
|
||||
}: React.HTMLAttributes<HTMLDivElement>) {
|
||||
return (
|
||||
<div
|
||||
className={cn("animate-pulse rounded-md bg-primary/10", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export { Skeleton };
|
114
src/lib/mdx.ts
114
src/lib/mdx.ts
@ -1,97 +1,25 @@
|
||||
import * as fs from "node:fs";
|
||||
import { Stats } from "node:fs";
|
||||
import path from "node:path";
|
||||
import config from "@/config";
|
||||
import simpleGit from "simple-git";
|
||||
import os from "node:os";
|
||||
import { cache } from "react";
|
||||
import "server-only";
|
||||
|
||||
/**
|
||||
* The regex to match for metadata.
|
||||
*/
|
||||
const METADATA_REGEX: RegExp = /---\s*([\s\S]*?)\s*---/;
|
||||
|
||||
/**
|
||||
* Check if the DOCS_DIR is a Git URL.
|
||||
*/
|
||||
const isGitUrl = (url: string): boolean => {
|
||||
return /^https?:\/\/|git@|\.git$/.test(url);
|
||||
};
|
||||
|
||||
/**
|
||||
* The directory docs are stored in.
|
||||
*/
|
||||
const DOCS_DIR: string = isGitUrl(config.contentSource)
|
||||
? config.contentSource
|
||||
: path.join(config.contentSource.replace("{process}", process.cwd()));
|
||||
|
||||
const LAST_UPDATE_FILE = path.join(
|
||||
os.tmpdir(),
|
||||
"docs_cache",
|
||||
"last_update.json"
|
||||
);
|
||||
const CACHE_DURATION_MS: number = 5 * 60 * 1000; // 5 minutes in milliseconds
|
||||
const DOCS_DIR: string = path.join(process.cwd(), "docs");
|
||||
|
||||
/**
|
||||
* Clone the Git repository if DOCS_DIR is a URL, else use the local directory.
|
||||
* If it's a Git URL, clone it to a cache directory and reuse it.
|
||||
* Get the content to
|
||||
* display in the docs.
|
||||
*/
|
||||
const getDocsDirectory = cache(async (): Promise<string> => {
|
||||
if (isGitUrl(DOCS_DIR)) {
|
||||
const repoHash: string = Buffer.from(DOCS_DIR).toString("base64"); // Create a unique identifier based on the repo URL
|
||||
const cacheDir: string = path.join(os.tmpdir(), "docs_cache", repoHash);
|
||||
|
||||
// Pull the latest changes from the repo if we don't have it
|
||||
if (!fs.existsSync(cacheDir) || fs.readdirSync(cacheDir).length < 1) {
|
||||
console.log("Cloning initial docs content from Git...");
|
||||
try {
|
||||
await simpleGit().clone(DOCS_DIR, cacheDir, { "--depth": 1 });
|
||||
storeUpdatedRepoTime();
|
||||
} catch (error) {
|
||||
// Simply ignore this error. When cloning the repo for
|
||||
// the first time, it'll sometimes error saying the dir
|
||||
// is already created.
|
||||
}
|
||||
} else if (shouldUpdateRepo()) {
|
||||
// Pull the latest changes from Git
|
||||
console.log("Pulling docs content from Git...");
|
||||
await simpleGit(cacheDir)
|
||||
.reset(["--hard"]) // Reset any local changes
|
||||
.pull(); // Pull latest changes
|
||||
storeUpdatedRepoTime();
|
||||
}
|
||||
return cacheDir;
|
||||
}
|
||||
return DOCS_DIR;
|
||||
});
|
||||
|
||||
const shouldUpdateRepo = (): boolean => {
|
||||
if (!fs.existsSync(LAST_UPDATE_FILE)) {
|
||||
return true;
|
||||
}
|
||||
return (
|
||||
Date.now() -
|
||||
JSON.parse(fs.readFileSync(LAST_UPDATE_FILE, "utf-8")).lastUpdate >
|
||||
CACHE_DURATION_MS
|
||||
);
|
||||
};
|
||||
|
||||
const storeUpdatedRepoTime = () =>
|
||||
fs.writeFileSync(
|
||||
LAST_UPDATE_FILE,
|
||||
JSON.stringify({ lastUpdate: Date.now() }),
|
||||
"utf-8"
|
||||
);
|
||||
|
||||
/**
|
||||
* Get the content to display in the docs.
|
||||
*/
|
||||
export const getDocsContent = async (): Promise<DocsContentMetadata[]> => {
|
||||
const docsDir: string = await getDocsDirectory();
|
||||
export const getDocsContent = (): DocsContentMetadata[] => {
|
||||
const content: DocsContentMetadata[] = [];
|
||||
for (const directory of getRecursiveDirectories(docsDir)) {
|
||||
content.push(...getMetadata<DocsContentMetadata>(docsDir, directory));
|
||||
for (const directory of getRecursiveDirectories(DOCS_DIR)) {
|
||||
content.push(...getMetadata<DocsContentMetadata>(DOCS_DIR, directory));
|
||||
}
|
||||
return content.sort((a: DocsContentMetadata, b: DocsContentMetadata) => {
|
||||
const orderA = a.order ?? Number.MAX_SAFE_INTEGER;
|
||||
@ -117,27 +45,18 @@ const getMetadata = <T extends MDXMetadata>(
|
||||
const extension: string = path.extname(file); // The file extension
|
||||
return extension === ".md" || extension === ".mdx";
|
||||
}); // Read the MDX files
|
||||
const metadata: T[] = [];
|
||||
for (let i = files.length - 1; i >= 0; i--) {
|
||||
const file: string = files[i];
|
||||
return files.map((file: string): T => {
|
||||
const filePath: string = path.join(directory, file); // The path of the file
|
||||
const fileMetadata: T | undefined = parseMetadata<T>(
|
||||
fs.readFileSync(filePath, "utf-8")
|
||||
);
|
||||
if (!fileMetadata) {
|
||||
continue;
|
||||
}
|
||||
metadata.push({
|
||||
return {
|
||||
slug: filePath
|
||||
.replace(parent, "")
|
||||
.replace(/\\/g, "/") // Normalize the path
|
||||
.replace(/\.mdx?$/, "")
|
||||
.substring(1),
|
||||
extension: path.extname(file),
|
||||
...fileMetadata,
|
||||
});
|
||||
}
|
||||
return metadata;
|
||||
...parseMetadata<T>(fs.readFileSync(filePath, "utf-8")),
|
||||
}; // Map each file to its metadata
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
@ -148,15 +67,8 @@ const getMetadata = <T extends MDXMetadata>(
|
||||
* @returns the metadata and content
|
||||
* @template T the type of metadata
|
||||
*/
|
||||
const parseMetadata = <T extends MDXMetadata>(
|
||||
content: string
|
||||
): T | undefined => {
|
||||
const extracted = METADATA_REGEX.exec(content);
|
||||
const metadataBlock: string | undefined =
|
||||
extracted && extracted.length > 1 ? extracted[1] : undefined; // Get the block of metadata
|
||||
if (!metadataBlock) {
|
||||
return undefined;
|
||||
}
|
||||
const parseMetadata = <T extends MDXMetadata>(content: string): T => {
|
||||
const metadataBlock: string = METADATA_REGEX.exec(content)![1]; // Get the block of metadata
|
||||
content = content.replace(METADATA_REGEX, "").trim(); // Remove the metadata block from the content
|
||||
const metadata: Partial<{
|
||||
[key: string]: string;
|
||||
|
@ -1,28 +0,0 @@
|
||||
import { type NextRequest, NextResponse } from "next/server";
|
||||
|
||||
export function middleware(request: NextRequest): NextResponse {
|
||||
const before: number = Date.now();
|
||||
const response: NextResponse = NextResponse.next();
|
||||
if (process.env.NODE_ENV === "production") {
|
||||
const ip: string | null =
|
||||
request.headers.get("CF-Connecting-IP") ||
|
||||
request.headers.get("X-Forwarded-For");
|
||||
console.log(
|
||||
`${ip} | ${request.method} ${request.nextUrl.pathname} ${response.status} in ${(Date.now() - before).toFixed(0)}ms`
|
||||
);
|
||||
}
|
||||
return response;
|
||||
}
|
||||
|
||||
export const config = {
|
||||
matcher: [
|
||||
/*
|
||||
* Match all request paths except for the ones starting with:
|
||||
* - api (API routes)
|
||||
* - _next/static (static files)
|
||||
* - _next/image (image optimization files)
|
||||
* - favicon.ico (favicon file)
|
||||
*/
|
||||
"/((?!api|_next/static|_next/image|favicon.ico).*)",
|
||||
],
|
||||
};
|
@ -24,15 +24,6 @@
|
||||
"paths": {
|
||||
"@/*": [
|
||||
"./src/*"
|
||||
],
|
||||
"@/config": [
|
||||
"./src/app/config.ts"
|
||||
],
|
||||
"@/types/*": [
|
||||
"./src/app/types/*"
|
||||
],
|
||||
"@/configJson": [
|
||||
"./config.json"
|
||||
]
|
||||
},
|
||||
"target": "ES2017"
|
||||
|
Reference in New Issue
Block a user