Skip to main content

Documentation Index

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

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

Colorful is a self-contained static theme, so GitHub Pages can serve it directly from the repository root with no build step required. The theme folder ships as ready-to-publish HTML, CSS, and JavaScript — the entire set of files is ready to go the moment you have personalized the content.

​
Prerequisites

Before you start, make sure you have:
  • A GitHub account — create one at github.com if you do not already have one.
  • A GitHub repository with the Colorful theme files placed at the root, so that index.html is at the top level of the repository rather than inside a subfolder.
Forking the Colorful repository directly is the fastest path to a correctly structured repository. All files land at the root automatically, and you can personalize the content from there.

​
Deployment steps

1

Confirm index.html and .nojekyll are at the repository root

Open your repository in GitHub and verify that index.html and .nojekyll appear at the top level — not inside a subfolder. The expected root-level layout is:
your-repo/
├── index.html
├── .nojekyll
├── assets/
├── components/
└── images/
If index.html is nested inside a folder, GitHub Pages will not find it and will return a 404.
2

Push all files to the main branch

Commit and push every file — including the hidden .nojekyll file — to the main branch of your repository. If you forked the repository, all files are already present.
git add .
git commit -m "Add Colorful portfolio theme"
git push origin main
3

Open repository Settings → Pages

In your GitHub repository, click the Settings tab, then select Pages from the left sidebar under the Code and automation section.
4

Configure the build and deployment source

Under the Build and deployment heading:
  • Set Source to Deploy from a branch
  • Set Branch to main
  • Set Folder to / (root)
The configuration should look like this once set:
Source: Deploy from a branch
Branch: main
Folder: / (root)
5

Save and wait for the site to go live

Click Save. GitHub Pages queues a build immediately. Within about a minute your portfolio will be available at:
https://<your-username>.github.io/<repo-name>/
For example, the live Colorful demo is hosted at:
https://apursley2012.github.io/colorful/
Renaming or moving index.html away from the repository root will break the GitHub Pages entry point and return a 404 for all visitors. Always keep index.html at the top level of the repository.
You can view the live Colorful demo at https://apursley2012.github.io/colorful/ to see exactly what a deployed portfolio looks like before you customize your own.

​
The .nojekyll file

GitHub Pages runs every repository through Jekyll by default. Jekyll ignores files and folders whose names start with an underscore, which can silently drop certain asset directories and interfere with asset path references in static themes. The .nojekyll file at the repository root tells GitHub Pages to skip Jekyll entirely and serve the files as-is. This is required for Colorful’s asset paths to resolve correctly. Do not delete it.

​
Custom domain

GitHub Pages supports custom domains at no extra cost. To use your own domain:
  1. Create a file named CNAME at the repository root containing your domain name (for example, yourportfolio.com).
  2. In repository Settings → Pages → Custom domain, enter the same domain and click Save.
  3. Update your DNS provider to point to GitHub Pages using the addresses provided in the GitHub Pages documentation.
Allow up to 24 hours for DNS changes to propagate.

​
Updating the site

Any new commit pushed to the main branch triggers a re-deploy automatically. There is no separate deploy command to run — edit your files locally, commit, push, and GitHub Pages will rebuild and publish the updated site within a minute or two. 
# Make your edits, then:
git add .
git commit -m "Update about page content"
git push origin main

​
Verifying the deployment

After saving the Pages settings or pushing a new commit:
  1. Open the Actions tab of your repository. You will see a workflow named pages build and deployment — a green check mark indicates a successful build.
  2. Visit your Pages URL (https://<your-username>.github.io/<repo-name>/) to confirm the site loads correctly.
  3. If the Actions tab shows a failed build, review the error output for path or configuration issues.

Build docs developers (and LLMs) love

Get started for freeTalk to us