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 static site — all HTML, CSS, and JavaScript assets are pre-compiled and ready to serve as-is. Deploying to GitHub Pages simply means pushing the repository files so that index.html sits at the repository root. GitHub Pages serves that file automatically as your site’s homepage with no build configuration required.
1

Create a GitHub repository

Go to github.com/new and create a new repository. Choose a name that fits your use case:
  • my-portfolio — results in a project URL like https://username.github.io/my-portfolio/
  • <username>.github.io — results in a root domain URL like https://username.github.io/
Leave the repository empty (do not initialize with a README) so you can push your local files without conflicts.
2

Push your files

From inside your local spooky/ folder, initialize a Git repository and push all files to GitHub:
git init
git add .
git commit -m "Initial spooky portfolio"
git branch -M main
git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO.git
git push -u origin main
Replace YOUR_USERNAME and YOUR_REPO with your actual GitHub username and repository name.
3

Enable GitHub Pages

In your GitHub repository, navigate to Settings → Pages.Under Source, configure the following and click Save:
Branch: main
Folder: / (root)
GitHub Pages will begin building your site immediately after you save.
4

Visit your site

Within a minute or two, your portfolio will be live at:
https://YOUR_USERNAME.github.io/YOUR_REPO/
If you used <username>.github.io as the repository name, your site will be available at:
https://YOUR_USERNAME.github.io/

​
Asset path notes

Internal asset paths in Spooky use relative URLs — for example, ./assets/main.js and ./components/Navigation.js. This means the theme works correctly when hosted at a GitHub Pages project URL like username.github.io/spooky/ without any path configuration changes. If you rename your repository, all asset paths still resolve correctly because they are relative to index.html rather than anchored to a specific domain or subfolder name.

​
Custom domain

GitHub Pages supports custom domains so your portfolio can be reached at your own address (e.g. www.yourname.com) instead of a github.io URL. To configure a custom domain:
  1. Create a file named CNAME at the root of your repository. The file should contain only your domain name, with no protocol prefix: 
    www.yourname.com
  2. In your DNS provider’s dashboard, create an A record or CNAME record pointing your domain to GitHub’s servers.
  3. Back in Settings → Pages, enter your custom domain and enable Enforce HTTPS once the certificate has been provisioned.
Refer to the GitHub Pages custom domain documentation for the current IP addresses and full DNS configuration instructions, as these values can change over time.

​
Jekyll bypass

If a .nojekyll file is present at the repository root, it tells GitHub Pages to skip its default Jekyll processing step entirely. For Spooky, this ensures that files and folders whose names begin with an underscore (such as _assets or _components, if you use that naming convention) are served correctly rather than being ignored by the Jekyll pipeline. Keep .nojekyll beside index.html at the root whenever it is included in the theme.
Test your deployed site on a mobile device right after publishing. Spooky is fully responsive, and the candle cursor is intentionally hidden on touch devices — that is expected behavior, not a bug. While you’re testing, also check that your navigation, project cards, and contact section all display correctly at small screen widths before sharing the link publicly.

Build docs developers (and LLMs) love

Get started for freeTalk to us