Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/a-master-artificer/llms.txt

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

GitHub Pages serves the A Master Artificer theme as a fully static site — no build command, CI/CD pipeline, package installation, or server configuration required. The theme ships as finished HTML, CSS, JavaScript, and image files that GitHub can host directly the moment you enable Pages on your repository.
After any commit to your publishing branch, GitHub Pages typically takes 1–2 minutes to reflect the changes on the live URL. If the updated site does not appear immediately, wait a moment and then do a hard refresh in your browser (Ctrl+Shift+R on Windows/Linux, Cmd+Shift+R on macOS).

Deployment steps

1
Confirm the required repository structure
2
index.html must sit at the root of the repository — not inside a subfolder. GitHub Pages looks for this file at the top level to serve your site automatically.
3
Correct structure:
4
a-master-artificer/
├── .nojekyll
├── index.html
├── assets/
├── components/
├── images/
├── pages/
└── README.md
5
Incorrect structure — index.html is buried one level too deep:
6
a-master-artificer/
└── a-master-artificer/
    ├── index.html
    └── assets/
7
When you upload the theme, drag the contents of the theme folder into GitHub — not the folder itself. If you see a nested folder with the same name as your repository, the files are one level too deep.
8
Create or prepare your GitHub repository
9
  • New repository: Go to github.com/new, give it a name (e.g. a-master-artificer), set it to Public, and click Create repository. A private repository requires a paid GitHub plan for Pages hosting.
  • Existing repository: Open the repository on GitHub and skip to the next step.
  • 10
    Upload the theme files
    11
    GitHub’s web UI lets you upload files without a local Git installation.
    12
  • Open your repository on GitHub.
  • Click Add fileUpload files.
  • Drag the theme’s folders and files (index.html, .nojekyll, assets/, components/, images/, pages/, etc.) into the upload area.
  • Verify that index.html appears at the top level of the repository after the upload — not inside a subfolder.
  • Verify that .nojekyll was included in the upload (it is a hidden dotfile and can be easy to miss).
  • Add a short commit message such as Add theme files.
  • Click Commit changes.
  • 13
    Enable GitHub Pages
    14
  • Open the repository on GitHub.
  • Click Settings in the top navigation bar.
  • Click Pages in the left sidebar.
  • Under Build and deployment, set the source to Deploy from a branch.
  • Set the branch and folder:
    Branch: main
    Folder: / (root)
    
  • Click Save.
  • 15
    GitHub will begin building and publishing your site. The first deployment usually takes about one to two minutes.
    16
    Confirm the published URL
    17
    GitHub Pages project sites follow this URL pattern:
    18
    https://<username>.github.io/<repository-name>/
    
    19
    For this theme hosted in its source repository, the live URL is:
    20
    https://apursley2012.github.io/a-master-artificer/
    
    21
    Your URL will match the same pattern with your own username and repository name. You can find the confirmed URL in Settings → Pages after the first deployment completes.
    22
    Test the live site
    23
    Open the published URL and check the following:
    24
  • The homepage loads without a 404 or blank screen.
  • Navigation links move between pages correctly.
  • Images and screenshots are visible and not broken.
  • Styling (fonts, colors, layout) renders as expected.
  • The custom cursor appears when hovering on desktop.
  • The astrolabe navigation button is visible in the bottom-right corner.
  • 25
    If anything looks wrong, see the Troubleshooting page for solutions to the most common issues.
    26
    Update the published site
    27
    Any commit pushed or made directly to the publishing branch triggers an automatic republish. You do not need to re-enable Pages or run any commands.
    28
    To edit a file through the GitHub web UI:
    29
  • Open the repository.
  • Click the file you want to change.
  • Click the pencil-shaped Edit this file button.
  • Make your changes.
  • Click Commit changes and add a short message.
  • Wait one to two minutes, then refresh the live URL to confirm the update.

  • Important files

    index.html

    index.html is the homepage and the GitHub Pages entry file. It must remain at the repository root. When someone visits your published URL, GitHub Pages serves this file automatically. Renaming it or moving it into a subfolder will cause the site to return a 404.

    .nojekyll

    .nojekyll is an empty file stored beside index.html at the repository root. Its filename alone is the instruction — GitHub Pages reads its presence and skips Jekyll processing, which allows folders and files starting with an underscore (such as _ prefixed paths) to be served without being filtered out. The file must be completely empty. The filename must be exact: Correct:
    .nojekyll
    
    Incorrect:
    nojekyll
    .nojekyll.txt
    nojekyll.md
    
    If the .nojekyll file was not included in your upload, add it by clicking Add file → Create new file in GitHub, typing .nojekyll as the filename, leaving the content area blank, and committing.

    Why _config.yml is not needed

    This theme does not require a _config.yml or config.yaml file. The presence of .nojekyll at the root is sufficient to tell GitHub Pages to publish the files directly without any Jekyll configuration.
    All internal paths in this theme are written as relative paths (for example, assets/main.css rather than /assets/main.css). This is intentional. GitHub Pages project sites are served from a subpath like /repository-name/, and absolute paths starting with / would resolve to the root of the entire github.io domain instead of your repository folder. Do not change relative paths to absolute paths when editing the theme.

    Build docs developers (and LLMs) love