Tech docs template Beta
Table of contents

Prerequisites for Macs

You must have the following set up on your mac laptop:

  • administrator rights on your laptop
  • text editor
  • Xcode command line interface tools [external link]
  • Ruby [external link]
  • Middleman static site generator [external link]

You must also have a GitHub account [external link] with access to alphagov at https://github.com/alphagov/paas-tech-docs.

Administrator rights on your laptop

Email sd-community@digital.cabinet-office.gov.uk to request administrator rights on your laptop.

You must be a Government Digital Service employee to do this.

Install text editor

You should install a text editor to edit your content.

Install Xcode command line interface tools

These instructions assume that you are the Managed Software Centre on your Mac.

  1. Go to the Managed Software Centre on your Mac.
  2. Select Updates.
  3. Install all required updates.
  4. Search for xcode in the search field in Updates.
  5. Install Xcode x.x.x or update if necessary.

OR

  1. Go to Apple Developer Downloads [external link].
  2. Search for “xcode”.
  3. Select the appropriate Command Line Tools (macOS x.x) for Xcode x.x and download the file.
  4. Install the file.

Install Ruby

Ruby [external link] is installed globally. This means that you can run the install command from any location on your local machine rather than from within a specific folder.

You can install Ruby in multiple ways, for example using Ruby Version Manager (RVM) or rbenv [external links]. These instructions assume you are using RVM.

  1. Run the following in the command line interface to install the ruby version manager:

    `\curl -sSL https://get.rvm.io | bash -s stable --ruby`
    
  2. Run rvm install ruby-x.x.x to install the latest version of Ruby. The current x.x.x is 2.6.1.

Install Middleman

Middleman [external link] is installed globally. This means that you can run the install command from any location on your local machine rather than from within a specific folder.

Run the following in the command line interface to install Middleman:

gem install middleman