how can i publish mediumish theme on github pages

table of contents

• Why use Mediumish on GitHub Pages
• Quick overview
• What you need before starting
• Prepare the theme on your computer
• Choose your deployment method
  • Method A Direct upload to GitHub Pages
  • Method B Deploy using GitHub Actions
  • Method C Push to gh-pages branch
• Adjust links and paths
• Set up custom domain and HTTPS
• Common issues and how to fix them
• Keeping your site up to date

Why use Mediumish on GitHub Pages

The Mediumish theme is well-known for its clean and professional design that makes content easy to read and visually appealing. Its minimalist style focuses the reader’s attention on the writing itself, without unnecessary distractions. This makes it a perfect choice for blogs, portfolios, and even documentation pages.

When you combine Mediumish with GitHub Pages, you get a free hosting solution that is reliable and fast. GitHub Pages serves your site from a global content delivery network, meaning visitors can access your content quickly from anywhere in the world. This is especially valuable for audiences spread across different countries.

Another reason to use this combination is simplicity. You don’t have to worry about setting up complex servers or paying monthly hosting fees. Everything is managed directly from your GitHub repository, which doubles as your backup. Every change you make is stored in version control, so you can roll back if something goes wrong.

Finally, hosting on GitHub Pages provides automatic HTTPS support, giving your site a professional and secure image. This can help boost trust with your readers and improve your ranking in search engines.

Quick overview

Before diving into the technical steps, it’s helpful to have a clear roadmap of the process. Deploying a theme like Mediumish to GitHub Pages involves setting it up locally, adjusting its configuration, pushing it to GitHub, and then activating GitHub Pages in the repository settings.

First, you will need to download or clone the theme files to your local machine. Then, you’ll make sure the theme runs properly locally before moving on to deployment. This step is crucial because any errors found early can be fixed quickly without affecting a live site.

Once the theme is ready, you will choose one of several deployment methods: direct upload, GitHub Actions automation, or manually pushing to a special branch. Each has its pros and cons, which we will discuss in detail later.

After deployment, you might need to fix broken paths for images or styles. You may also want to connect a custom domain and enable HTTPS. We’ll also cover common problems you might face and how to fix them effectively.

What you need before starting

Before starting the deployment process, make sure you have everything you need. Skipping these preparations can lead to delays or errors later in the process.

You will need a GitHub account. If you don’t already have one, you can sign up for free on GitHub’s official website. Once your account is ready, make sure you have Git installed on your computer so you can manage files and push updates to your repository.

Next, you need the Mediumish theme files. You can either download them from a trusted source or clone them from a Git repository. If your version of Mediumish is based on Jekyll or another static site generator, you’ll also need to have that tool installed on your computer.

While not required, basic knowledge of HTML and CSS will help you customize the theme later. If you know how to use a text editor like VS Code or Sublime Text, the process will be much smoother.

Prepare the theme on your computer

Setting up the theme locally ensures that it works correctly before you publish it. This step allows you to preview your site and make changes without affecting visitors.

Start by downloading the Mediumish theme into a dedicated folder. Organize the files so they are easy to manage. Delete any placeholder content you don’t need, such as example posts or unused images.

Once your files are ready, you can preview the site locally. If your theme is pure HTML and CSS, simply open the index.html file in your browser. If it requires Jekyll or another static site generator, you’ll need to run the build command in your terminal and open the local server link provided.

By testing locally, you can catch design issues, missing images, or broken links early. This saves time and prevents embarrassing mistakes on your live site.

example folder layout

path	purpose
index.html	Main homepage file
assets/css	Stylesheets for layout and design
assets/js	JavaScript for interactivity
images	Image files used in the theme
_posts	Post source files if using Jekyll

Choose your deployment method

GitHub Pages offers multiple ways to publish your site. The method you choose will depend on the complexity of your theme and your workflow preferences.

Method A Direct upload to GitHub Pages

This is the simplest method for static HTML versions of Mediumish. You create a new GitHub repository, upload your files through the GitHub interface, and activate GitHub Pages in the settings. The site goes live almost immediately.

While easy, this method can be slow if you need to make frequent updates because you have to manually upload files each time. However, it’s great for beginners or for sites that don’t change often.

Method B Deploy using GitHub Actions

GitHub Actions allows you to automate the deployment process. Whenever you push changes to your repository, GitHub will automatically build and publish your site based on the workflow file you set up. This is ideal if your theme needs preprocessing steps like compiling Sass or running a static site generator.

Automation saves time and ensures consistency, making it a great choice for regular bloggers or developers who frequently update their sites.

Method C Push to gh-pages branch

With this method, you build your site locally and push the generated files to a special branch called gh-pages. GitHub Pages will serve the content of that branch directly. This method gives you full control over the build process but requires you to remember to build and push manually each time.

Adjust links and paths

After your site is live, you might notice some images or CSS files not loading correctly. This is often caused by incorrect file paths. GitHub Pages serves project sites from a subdirectory, so absolute paths pointing to the root might break.

To fix this, use relative paths or configure your site’s base URL properly. For example, in Jekyll, you can set the baseurl in your configuration file. Always test links locally before pushing updates to avoid downtime.

Developer tools in your browser can help identify broken assets. Open the console or network tab, refresh the page, and look for errors. Once you find the problematic paths, correct them and redeploy.

Set up custom domain and HTTPS

Connecting a custom domain makes your site more memorable and professional. You can register a domain through a provider like Namecheap or Google Domains, then point it to your GitHub Pages site by adjusting DNS settings.

Once your domain is set up, GitHub Pages offers free HTTPS certificates. Enabling HTTPS ensures data between your site and visitors is encrypted, which increases trust and can improve SEO.

example dns setup

For example.com, point A records to GitHub Pages IP addresses and set a CNAME record for www pointing to username.github.io.

Common issues and how to fix them

Even with careful setup, you might run into issues. Common problems include broken links, missing images, and site not updating after changes. These are usually caused by incorrect paths, caching, or pushing files to the wrong branch.

Clearing your browser cache, verifying your GitHub Pages settings, and checking your repository structure can resolve most issues quickly.

quick troubleshooting checklist

1. Check if index.html is in the correct publishing branch.
2. Verify that all CSS and JS paths are correct.
3. Test your site with a local server before pushing.
4. Update baseurl if you are using a project site.

Keeping your site up to date

Once your site is live, keeping it updated is important for security, SEO, and user experience. Add new posts or pages regularly to keep readers engaged. Review your theme’s GitHub repository for updates or bug fixes you can apply.

It’s also wise to periodically check your site on different devices to ensure it looks good everywhere. Mobile responsiveness is especially important for modern web traffic.