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.

You can have a live, fully styled portfolio at a public GitHub Pages URL in under five minutes. There is no npm to run, no CLI to install, no server to configure, and no build step of any kind. Artisan Developer is a fully static theme — the files you download are exactly the files that get published. All you need is a GitHub account, a text editor, and five minutes to follow these steps.

​
Prerequisites

Before you start, make sure you have the following:
  • A free GitHub account
  • A text editor such as VS Code, SPCK Editor, or any editor that can open and save .html files
  • Basic ability to edit HTML — you only need to find and replace text like your name, job title, and project descriptions
1

Fork or download the theme

Go to the Artisan Developer repository at https://github.com/apursley2012/artisan-developer and choose one of the following:
  • Fork the repository — click the Fork button in the top-right corner of the page. This creates a copy of the theme under your own GitHub account and is the fastest path to publishing.
  • Download as ZIP — click Code > Download ZIP, unzip the archive on your computer, then create a new GitHub repository and upload all the extracted files.
Either way, the critical requirement is that index.html must sit directly at the root of your repository — not inside a subfolder. GitHub Pages looks for index.html at the root to serve your site.
2

Verify the file structure

Before enabling GitHub Pages, confirm that your repository contains all of the required files and folders at the correct paths. The root of your repository should look like this:
artisan-developer/
├── .nojekyll
├── index.html
├── assets/
├── components/
├── pages/
└── images/
Check that .nojekyll, index.html, and the four folders — assets/, components/, pages/, and images/ — are all present at the top level.
If index.html is inside a subfolder (for example, artisan-developer/artisan-developer/index.html), GitHub Pages will serve a 404 error instead of your portfolio. Move all files up to the repository root before enabling Pages.
3

Customize your content

Open index.html and the files inside the pages/ folder in your text editor. Replace the placeholder content with your own information:
  • Your name and headline — update the homepage introduction in index.html
  • About page — edit pages/About.html with your biography, background, and career story
  • Projects — add your work to pages/Projects.html
  • Skills — update pages/Skills.html with your tools and technologies
  • Work history — fill in pages/Work.html with your professional experience
  • Case studies — use pages/CaseStudies.html for in-depth project writeups
  • Blog — add writing or articles to pages/Blog.html
  • Testimonials — add feedback or recommendations to pages/Testimonials.html
  • Contact — update your email, GitHub, LinkedIn, and other links in pages/Contact.html
The navigation uses artisan-themed labels — “The Swirl” links to the homepage, “Out of the Dye Bath” links to About, “The Color Wheel” links to Projects, “Pigments” links to Skills, “The Long Strip” links to Work, “Deep Dyes” links to Case Studies, “Field Notes” links to Blog, “Drop a Note” links to Contact, and “Kind Words” links to Testimonials. You can change any of these labels inside components/SwirlNav.js in the component’s route array.
4

Enable GitHub Pages

Once your files are uploaded and your content is updated, turn on GitHub Pages publishing:
  1. Open your repository on GitHub.
  2. Click Settings in the top navigation bar.
  3. Click Pages in the left sidebar under “Code and automation.”
  4. Under Build and deployment, set the source to Deploy from a branch.
  5. Set the branch to main and the folder to / (root).
  6. Click Save.
After saving, GitHub Pages will begin building your site. The published URL will follow this pattern:
https://<username>.github.io/<repo-name>/
For example, if your GitHub username is jsmith and your repository is named my-portfolio, your site will be live at https://jsmith.github.io/my-portfolio/.
5

Confirm the live site

Visit your published URL and run through the following checks:
  • The homepage loads with your name and headline
  • All navigation links work and lead to the correct pages
  • Images display correctly
  • The styling and custom fonts load as expected
If the page shows a 404 or appears unstyled immediately after enabling Pages, wait one to two minutes and refresh — GitHub Pages can take a short time to finish the first build after publishing is enabled.
Once you are happy with your customized portfolio, replace the screenshots inside images/screenshots/ with fresh screenshots of your personalized site. The README on your GitHub repository pulls those images for its preview gallery, so updating them gives your repository page a professional, on-brand appearance that matches your live site.

Build docs developers (and LLMs) love

Get started for freeTalk to us