Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/spooky/llms.txt

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

Spooky is a pre-built static site — all HTML, CSS, and JavaScript files are already compiled and ready to render in a browser. There is no npm install, no build step, and no framework to configure before you can preview the theme locally. Download the repository, serve it over HTTP, and your Halloween portfolio is live on your machine in seconds.
1

Clone or download

Clone the Spooky repository from GitHub and move into the project folder:
git clone https://github.com/apursley2012/spooky.git
cd spooky
Alternatively, download the ZIP from the repository page and extract it to a local directory.
2

Open locally

Spooky uses ES module imports, which means browsers block the scripts when a page is opened directly as a file:// URL. You must serve the project over HTTP. Choose one of the two options below:
python3 -m http.server 8080
3

Preview in browser

Open your browser and navigate to:
http://localhost:8080
The full homepage loads immediately. The candle cursor, flickering lights, and slide-in navigation are all active — no further setup needed.
4

Personalize content

All editable content lives directly inside the HTML files. Open any of the following pages in your editor and replace the placeholder text, links, and details with your own:
FileContent
index.htmlHomepage — hero copy, intro statement
home.htmlAlternate homepage entry retained by the theme
about.htmlBiography and background
projects.htmlFeatured project portfolio
skills.htmlSkills, technologies, and capabilities
work.htmlProfessional experience and work history
casestudies.htmlDetailed project and technical breakdowns
articles.htmlWriting archive and article index
writing.htmlArticles, notes, and long-form writing
testimonials.htmlTestimonials and feedback
contact.htmlContact details and communication links
placeholders.htmlTheme placeholder and utility preview page
5

Replace placeholder screenshots

After personalizing your content, swap out the placeholder images inside images/screenshots/ with real screenshots of your finished pages. These images appear in social previews and any gallery sections you include in your portfolio.
The JavaScript files inside assets/ (main.js, index.js, proxy.js, etc.) and components/ (CandleCursor.js, Navigation.js, FlickeringLights.js, and others) are pre-compiled Vite output. Editing them directly is not recommended. Developers who want to modify component behavior — such as adjusting the candle cursor, jump-scare effects, or navigation animations — should refer to the Components section of this documentation.

What to customize first

Personal info

Update your name, bio, and background in about.html. This is the first place visitors go after the homepage.

Projects

Showcase your work by editing projects.html. Add titles, descriptions, links, and screenshot images for each project.

Color palette

Spooky ships with a Halloween-inspired palette. Learn how to adjust accent colors and background tones to fit your personal brand.

Typography

Review the font choices and heading scale used across the theme. Swap typefaces or adjust sizing to match your style.

Build docs developers (and LLMs) love