Skip to main content

Documentation Index

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

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

GitHub Pages hosts static files directly from a repository at no cost, and Artisan Developer is designed to work with it out of the box. There is no build step, no server to configure, and no deployment pipeline to manage — once the files are in the right place and GitHub Pages is enabled, the site goes live at a public URL automatically.

​
Required repository structure

For GitHub Pages to serve the site correctly, index.html must sit directly at the repository root, not inside any subfolder. Correct structure: 
artisan-developer-github-pages-theme/
├── .nojekyll
├── index.html
├── assets/
├── components/
├── pages/
└── images/
Incorrect structure: 
artisan-developer-github-pages-theme/
└── artisan-developer-github-pages-theme/
    ├── index.html
    └── assets/
If index.html is inside a subfolder rather than at the repository root, GitHub Pages will not find it and the site will show a 404 error.

​
Uploading theme files

Upload the theme files using GitHub’s built-in file uploader — no Git client or command line is required.
1

Create or open the GitHub repository

Navigate to your GitHub account and either create a new repository or open an existing one where you want to host the theme.
2

Select Add file → Upload files

On the repository’s main page, select the Add file button, then choose Upload files from the dropdown menu.
3

Drag the theme files and folders into the upload area

Open the downloaded theme folder on your computer and drag all of its contents — files and folders together — into the upload area on the GitHub page.
4

Confirm index.html appears at the top level

After dragging, check the file list on the upload page and confirm that index.html is listed at the top level, not nested inside a subfolder.
5

Confirm all required folders and files are present

Verify that .nojekyll, assets/, components/, pages/, and images/ all appear in the uploaded file list alongside index.html.
6

Add a commit message and select Commit changes

Scroll down to the commit section, add a short commit message such as Add Artisan Developer theme files, and select Commit changes to finish the upload.

​
Enabling GitHub Pages

After the files are uploaded, enable GitHub Pages in the repository settings to publish the site.
1

Open the repository on GitHub

Navigate to the repository that contains the uploaded theme files.
2

Select Settings

Select the Settings tab near the top of the repository page.
3

Select Pages from the sidebar

In the left sidebar under the Code and automation section, select Pages.
4

Choose Deploy from a branch

Under Build and deployment, open the Source dropdown and choose Deploy from a branch.
5

Set the branch and folder

Set the branch to main and the folder to / (root).
Branch: main
Folder: / (root)
6

Select Save

Select Save to apply the settings. GitHub Pages will begin building and publishing the site.

​
Confirming the published URL

Once GitHub Pages finishes building, the site is published at a URL following this pattern: 
https://<username>.github.io/<repo-name>/
For example, the live demo for this theme is available at: 
https://apursley2012.github.io/artisan-developer/
It may take one to two minutes after the first publish for the URL to become active. Once it is live, open the URL and test the following to confirm everything is working:
  • The homepage loads with full styling applied
  • Navigation links open the correct pages
  • Images display without broken image icons
  • Interactive effects and animations are running
  • The page layout looks correct on both desktop and mobile

​
Updating the published site

Committed changes to the branch that GitHub Pages is set to publish from are republished automatically. There is no need to re-enable GitHub Pages or change any settings after the initial setup. After editing and committing files, wait for GitHub Pages to finish rebuilding — then refresh the live site to see the changes.

​
Important files

Two files at the repository root are required for GitHub Pages to serve the Artisan Developer theme correctly. index.html index.html is the homepage and the GitHub Pages entry file. GitHub Pages looks for this file at the repository root when a visitor opens the published URL. It must remain at the root and must not be renamed or moved into a subfolder. .nojekyll .nojekyll is an empty file stored beside index.html at the repository root. It tells GitHub Pages to publish the files directly instead of treating the repository as a Jekyll site. The file must be named exactly .nojekyll — not nojekyll, .nojekyll.txt, or nojekyll.md.
The .nojekyll file is empty — it contains no content. It is a signal file only; its presence in the repository root is what matters, not its contents. Without it, GitHub Pages may fail to serve the JavaScript module files the theme depends on.

Build docs developers (and LLMs) love

Get started for freeTalk to us