Overview
publishing
Welcome to the Publishing section, where we delve into the intricacies of creating, managing, and sharing content on our academic website. This section focuses on the use of modern technologies, such as CI/CD and GitHub, to streamline the content publishing process. Our aim is to provide insights into the workflows and techniques that make it easier for you to maintain and update your online resources, allowing you to focus on delivering high-quality, informative posts across various disciplines. Join us as we explore the world of efficient content deployment and management, ensuring that your academic website remains current, engaging, and informative.
Welcome to the first instalment in our series on seamless web publishing with CI/CD, delivered with the practicality and subtle humour of a certain dry-witted economics teacher.
Setup
Hugo installation and theme selection: Begin by installing Hugo and selecting a theme that suits your fancy. Hugo theme customisation: Personalise your chosen theme to your heart’s content. Netlify and GitHub integration: Integrate Netlify and GitHub for a harmonious union in the cloud.
In this segment, we’ll guide you through the process of installing Hugo and selecting a theme. Let’s embark on this adventure together, with the same wit and practicality you’ve come to expect.
First, create a repository on GitHub (or a similar platform) and clone the new repository into a directory on your computer.
% mkdir statistical-bias % cd statistical-bias % git clone git@github.com:zaandahl/statistical-bias.git To install Hugo and set up a theme, we primarily followed the Quick Start guide on gohugo.
After selecting your Hugo theme, it’s time to make it your own. In this section, we’ll guide you through customising the theme to better represent your site.
For our particular theme, we began by adding a new homepage image (located under /static/images/). Next, we modified the config.toml file to update the title and point to the new homepage image. You can also change the logo image for the site (found under /static/images/) and update the default menus.
In this post, we’ll explore the harmonious union of Netlify and GitHub, two essential tools for modern web development. By integrating these platforms, you can automate your deployment process and streamline your publishing experience.
Step 1: Push Your Hugo Site to GitHub
Before integrating Netlify and GitHub, ensure that your Hugo site is pushed to a GitHub repository:
% git add . % git commit -m "Initial commit of Hugo site" % git push Step 2: Create a Netlify Account
In this final step of the Setup series, we’ll take a look at configuring your DNS settings to ensure your domain is properly connected to your site. For this example, we’ll use mydomain.com as the domain registrar and statisticalbias.com as the domain name.
Step 1: Add a Custom Domain in Netlify
Navigate to your site’s dashboard on Netlify. Click “Domain settings” and then “Add custom domain.” Enter your domain name (e.
Welcome to the first post in our Workflow series. In this instalment, we’ll discuss how to organise your post ideas using Joplin and explore formatting strategies for posts that work seamlessly with advanced chat AI (like yours truly). Additionally, we’ll offer some alternative Markdown editors you might consider.
Organising Your Post Ideas in Joplin
To keep your post ideas organised in Joplin, consider the following tips:
Notebooks: Create a dedicated Notebook for your page, with separate sub-notebooks for each category or topic.
Welcome to the second instalment of our Workflow series. Today, we’ll discuss how to add a Markdown heading section for Hugo, export Markdown notes from Joplin, and incorporate an image from DALL-E in your post.
Adding a Markdown Heading Section for Hugo
In your Markdown file, add a heading section for Hugo by following these examples:
Title: title: "My New Post" Escaping Apostrophes: title: "It''s a Wonderful Life" Weight: weight: 10 Categories: categories: ["Publishing", "Bayesian Statistics"] Tags: tags: ["workflow", "export"] Date: date: 2023-04-01 Different Hugo themes may utilise these features in various ways.
In this part of our Workflow series, we’ll guide you through organising your posts and pushing them to GitHub. We’ll discuss two processes: a simple one for working with your AI friend, and a more complex one for collaborating with teams.
Getting Your Posts in Order
To prepare posts for GitHub, ensure they are organised correctly:
Store posts in appropriate directories. For example, all publishing posts go under ./content/publishing/. Each post should be in a subdirectory with a single file named index.
In this final instalment of our publishing series, we’ll explore the wonders of CI/CD and how our publishing pipeline with Joplin, Hugo, GitHub, and Netlify makes our lives easier.
CI/CD: A Brief Overview
CI/CD stands for Continuous Integration and Continuous Deployment. It’s a modern software development practice that automates the process of building, testing, and deploying code. CI/CD has revolutionised web publishing, making it faster and more reliable. It has become a vital component in the world of cloud computing.