Skip to main content

Documentation Index

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

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

GitHub Pages is a free static hosting service built directly into GitHub. Color Melt is designed for it — no build step, no server, and no paid hosting required. Upload the theme files, point GitHub Pages at the root of your repository, and your site is live.

​
Required Repository Structure

index.html must be at the repository root, not inside a subfolder. GitHub Pages looks for it there first. If it’s nested one level down, the site either returns a 404 or loads without any styles or scripts. Upload the contents of the theme folder, not the folder itself.
Correct structure
your-repo/
├── .nojekyll
├── index.html
├── assets/
├── components/
├── pages/
└── images/
Incorrect — nested folder will break the site
your-repo/
└── color-melt/
    ├── index.html
    └── assets/
The second layout creates an unnecessary folder layer. GitHub Pages won’t find the homepage where it expects it.

​
Upload the Files

1

Create or open a repository

Go to github.com and create a new repository, or open an existing one you want to use for the site.
2

Open the file upload screen

Click Add file in the repository toolbar, then click Upload files.
3

Drag the theme files into the upload area

Open the extracted Color Melt folder on your computer. Select all the files and folders inside it and drag them into the upload area on GitHub. Do not drag the outer folder itself — drag its contents.
4

Confirm index.html is at the top level

After the upload completes, check that index.html appears directly in the repository root, not inside any subfolder.
5

Confirm .nojekyll and all asset folders were uploaded

Verify that .nojekyll, assets/, components/, pages/, and images/ all appear at the root level beside index.html.
6

Commit the upload

Add a commit message — something like Add Color Melt theme files — then click Commit changes.

​
Enable GitHub Pages

1

Open the repository Settings

Navigate to your repository on GitHub and click the Settings tab near the top of the page.
2

Open the Pages settings

Click Pages in the left sidebar under the “Code and automation” section.
3

Set the deployment source

Under Build and deployment, select Deploy from a branch from the Source dropdown.
4

Configure the branch and folder

Set Branch to main and Folder to / (root), then confirm both are selected.
5

Save

Click Save. GitHub will queue a Pages build immediately.
6

Wait for the build to finish

The first build usually takes a minute or two. Refresh the Pages settings screen — once the build is complete, your live URL will appear at the top of the page.

​
Your Live URL

Once GitHub Pages finishes building, your site will be available at: 
https://yourusername.github.io/your-repo-name/
Replace yourusername with your GitHub username and your-repo-name with the exact repository name. The first publish can take a couple of minutes — if the URL returns a 404 right away, wait a moment and try again.

​
Important Files

Two files at the repository root are required for GitHub Pages to work correctly.

​
index.html

index.html is the homepage and the GitHub Pages entry point. It must remain at the repository root at all times. If it moves into a subfolder, the site will return a 404 when someone visits the root URL.

​
.nojekyll

.nojekyll is an empty file that sits beside index.html. Its filename is the instruction — it tells GitHub Pages to publish the files directly instead of trying to process the repository as a Jekyll site. Without it, GitHub Pages may ignore folders and files whose names begin with an underscore, which can silently break parts of the theme. The file must be named exactly right, with the leading dot and no extension:
Correct
.nojekyll
Incorrect
nojekyll
.nojekyll.txt
Both incorrect versions will be ignored — GitHub Pages won’t recognize them as the Jekyll bypass signal.

​
Updating the Live Site

Committed changes to the publishing branch are republished automatically. You don’t need to re-enable Pages or change any settings after the initial setup. To edit a file directly on the GitHub website:
  1. Open the repository and navigate to the file you want to change.
  2. Click the pencil Edit this file button in the top-right corner of the file view.
  3. Make your changes in the editor.
  4. Add a commit message and click Commit changes.
  5. Wait for the Pages build to finish, then refresh the live URL to see the update.
Test the published URL on both desktop and a real mobile device. Decorative spacing and animations can behave differently on small screens.

Build docs developers (and LLMs) love

Get started for freeTalk to us