Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/v-doom/llms.txt

Use this file to discover all available pages before exploring further.

v-doom is a fully-featured developer portfolio template wrapped in an occult aesthetic. Built with React 18, React Router v6, Framer Motion, and Tailwind CSS, it provides six polished pages — home, about, projects, skills, experience, and contact — along with a suite of animated components including tarot cards, a rune circle, a particle background, and a custom cursor. The template ships as a static site compatible with GitHub Pages out of the box.

Quickstart

Clone, install, and run your portfolio in under five minutes.

Project Structure

Understand how the codebase is organized before you start customizing.

Customize Your Persona

Swap out the name, bio, skills, experience, and projects for your own.

Theme & Colors

Adjust the midnight/violet/amber color palette and typography to fit your brand.

What’s included

v-doom ships with everything you need to deploy a striking portfolio without starting from scratch.

TarotCard

Animated flip cards used for past/present/future and project showcases.

ParticleBackground

Full-viewport floating particle canvas that reacts to scroll.

RuneCircle

Rotating SVG rune decoration layered behind hero headings.

Custom Cursor

A smooth animated cursor dot and follower ring replacing the default pointer.

Layout

Root shell that composes the nav, cursor, particles, and page transitions.

Navigation

Fixed top nav with active-route indicator and animated underline.

Getting started

1

Clone the repository

git clone https://github.com/apursley2012/v-doom.git
cd v-doom
2

Install dependencies

npm install
3

Start the dev server

npm run dev
Open http://localhost:5173 to see your portfolio running locally.
4

Customize and deploy

Edit the content in assets/main.js or the source files to replace the placeholder persona with your own information, then deploy to GitHub Pages with npm run build.
v-doom uses a custom cursor that hides the native OS cursor. If you need to disable it for accessibility reasons, see the Cursor component docs.

Build docs developers (and LLMs) love