Skip to content

Commit

Permalink
Switched to pnpm, Added catppuccin theme, Added Contributors Page, Ov…
Browse files Browse the repository at this point in the history
…erhauled Every Article
  • Loading branch information
Justus0405 committed Dec 14, 2024
1 parent 6008dd0 commit 04d505b
Show file tree
Hide file tree
Showing 49 changed files with 2,686 additions and 5,268 deletions.
25 changes: 19 additions & 6 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,44 +1,58 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
# with:
# version: 9 # Not needed if you've set "packageManager" in package.json
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci
run: npm ci # or pnpm install / yarn install / bun install
- name: Build with VitePress
run: npm run docs:build
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
Expand All @@ -49,5 +63,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

uses: actions/deploy-pages@v4
25 changes: 2 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,3 @@
<h1 align="center">

ArchWiki - OCD Edition

<img src="https://archlinux.org/static/logos/archlinux-logo-light-scalable.1ae4cc2e2469.svg" width="200" alt="Arch Linux Logo" />

</h1>

Welcome to **ArchWiki - OCD Edition**: your meticulously organized and alternative source for Arch Linux documentation. Designed for enthusiasts and beginners alike, this wiki offers a seamless guide to installaing Arch Linux.

<a href="https://archlinux.org/" target="_blank"><img alt="Arch" src="https://img.shields.io/badge/ARCH-1793D1?style=flat-square" width="65"></a> <a href="https://Justus0405.github.io/Arch-Wiki/" target="_blank"><img alt="Wiki" src="https://img.shields.io/badge/WIKI-98c379?style=flat-square" width="58"></a>

## About

This project aims to provide a structured and user-friendly alternative to the traditional Arch Wiki. The **OCD Edition** ensures clarity and completeness while maintaining Arch Linux's philosophy of simplicity and customization.

## Explore the Documentation

Visit the full ArchWiki - OCD Edition at: [Arch-Wiki Documentation](https://Justus0405.github.io/Arch-Wiki/)


[check]: https://github.com/Justus0405/Arch-Wiki/actions/workflows/deploy.yml/badge.svg
[link]: https://github.com/Justus0405/Arch-Wiki/actions/workflows/deploy.yml
![Arch Linux Logo](https://archlinux.org/static/logos/archlinux-logo-light-scalable.1ae4cc2e2469.svg)

Welcome to the ArchWiki - OCD Edition: your alternative source for Arch Linux documentation on the web.
121 changes: 121 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Arch Wiki",
description: "My Personal Arch Linux Notes",
base: "/Arch-Wiki/",
head: [
["link", { rel: "icon", href: "/Arch-Wiki/archx.webp" }]
],

themeConfig: {
logo: "/archx.webp",
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: "Home", link: "/" },
{ text: "Guide", link: "/getting-started/introduction" },
{
text: "Resources",
items: [
{ text: "Download Arch Linux", link: "https://archlinux.org/download/" },
{ text: "Arch Wiki", link: "https://wiki.archlinux.org/" }
],
},
],
sidebar: [
{
text: 'Getting Started',
collapsible: true,
collapsed: false,
items: [
{ text: 'Base-Installation', link: '/1-getting-started/inside-iso.md' },
{ text: 'Enviroment-Installation', link: '/1-getting-started/inside-enviroment.md' },
{ text: 'Grub-Installation', link: '/1-getting-started/grub-install.md' }
]
},
{
text: 'Pacman',
collapsible: true,
collapsed: false,
items: [
{ text: 'Pacman', link: '/2-pacman/pacman.md' },
{ text: 'Mirror List', link: '/2-pacman/mirrorlist.md' },
{ text: 'Keyring Troubleshooting', link: '/2-pacman/keyrings.md' }
]
},
{
text: 'Graphics Drivers',
collapsible: true,
collapsed: false,
items: [
{ text: 'Nvidia', link: '/3-gpu-drivers/install-nvidia.md' },
{ text: 'Nvidia Depricated', link: '/3-gpu-drivers/nvidia-depricated.md' }
]
},
{
text: 'Sound',
collapsible: true,
collapsed: false,
items: [
{ text: 'PipeWire Setup', link: '/4-sound/pipewire.md' }
]
},
{
text: 'Desktop Environments',
collapsible: true,
collapsed: false,
items: [
{ text: 'GNOME Installation', link: '/5-desktop/install-gnome.md' }
]
},
{
text: 'Tiling Window Managers',
collapsible: true,
collapsed: true,
items: [
{ text: 'Hyprland', link: '/6-wm/hyprland.md' },
{ text: 'i3wm', link: '/6-wm/i3.md' },
{ text: 'Dwm', link: '/6-wm/dwm.md' }
]
},
{
text: 'Essential Configurations',
collapsible: true,
collapsed: false,
items: [
{ text: 'Fonts', link: '/7-essentials/install-fonts.md' },
{ text: 'NTP Setup', link: '/7-essentials/ntp.md' }
]
},
{
text: 'Laptop-Specific',
collapsible: true,
collapsed: false,
items: [
{ text: 'Prevent Lid closing', link: '/8-laptop/prevent-lid.md' },
{ text: 'Battery Optimization', link: '/8-laptop/battery-optimizations.md' }
]
},
{
text: 'Special Thanks',
collapsible: true,
collapsed: false,
items: [
{ text: 'Contributors', link: '/9-extra/contributors.md' }
]
}
],

socialLinks: [
{ icon: "github", link: "https://github.com/Justus0405" },
{ icon: "discord", link: "https://discord.com/invite/E2Bp7GtcaA" }
],

search: {
provider: "local"
},
returnToTopLabel: 'Return to Top',
sidebarMenuLabel: 'Sidebar Menu'
}
})
134 changes: 0 additions & 134 deletions docs/.vitepress/config.ts

This file was deleted.

16 changes: 3 additions & 13 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import DefaultTheme from "vitepress/theme";
import "@catppuccin/vitepress/theme/mocha/blue.css";

export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
})
},
enhanceApp({ app, router, siteData }) {
}
} satisfies Theme
export default DefaultTheme;
Loading

0 comments on commit 04d505b

Please sign in to comment.