aboutsummaryrefslogtreecommitdiff
path: root/build/windows/index.html
blob: 215ecce6d2342307144b0678b18e96da9915efab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!doctype html>
<html lang="en" id="top">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="icon" href="data:,">
	<title>Setting Up Jekyll on Windows
</title>
	<link href="https://bt.ht/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" />
	<style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}table{text-align:left;width:100%;}</style>
</head>

<nav>
  <a href="#menu">Menu &darr;</a>
</nav>

<main>
<h1>Setting Up Jekyll on Windows
</h1>
<p>
2022-09-02

I've recently been playing around with using Windows 10 as my daily operating system. So far, it has been going fairly well. Nothing will probably ever feel as "optimized" as running a Linux-based system but it works well for my current needs. Getting a Jekyll development environment setup was a different story though...

One of the first issues with using Windows 10 is the need to run a few of my open source projects that are built off Jekyll locally. This process initially seemed a like complex process to get things running smoothly but in the end was very straightforward. The main issue came from needing to bounce around through a handful of separate tutorials to get everything running smoothly.

So, I thought I would make this quick write-up to help those in the same situation (or even for my future self the need arises). Let's get into it.

</p>
<h2>WSL
</h2>
<p>
The first step involves installing <a href="https://docs.microsoft.com/en-us/windows/wsl/install">WSL</a> in order to run Linux alongside the main Windows OS. The documentation is well written and will get you up-and-running in no time. For quick reference, it essentially comes down to:

</p>

<ol>
<li>Opening PowerShell or Command Prompt as an administrator
</li>
<li>Installing via the command: <code>wsl --install</code>
</li>
<li>Restarting your machine after the install completes
</li>
<li>Creating your UNIX username and password
</li>
</ol>
<p>
</p>
<h2>Installing Ruby &amp; Dependencies
</h2>
<p>
Once logged into your UNIX terminal session (with your created user) you can begin installing everything we need for Jekyll to work properly. The first step is to installing <code>rvm</code> and the <a href="https://github.com/rvm/ubuntu_rvm">official project documentation</a> does a very good job of walking you through this.

</p>

<ul>
<li>Be sure dependencies as installed: <code>sudo apt-get install software-properties-common</code>
</li>
<li>Add the PPA and install the package:
</li>
</ul>
<p>

</p>
<pre><code>sudo apt-add-repository -y ppa:rael-gc/rvm
sudo apt-get update
sudo apt-get install rvm
</code></pre>
<p>

</p>

<ul>
<li>Add your existing user to the <code>rvm</code> group: <code>sudo usermod -a -G rvm $USER</code>
</li>
</ul>
<p>
You will need to close and restart your session to your Ubuntu system for these changes to take. After that, we can use <code>rvm</code> to install the latest version (at this time of writing) of ruby:


</p>
<pre><code>rvm install 3.1.2
</code></pre>
<p>

That's it!

</p>
<h2>Jekyll - Finally!
</h2>
<p>
The final step is to update our gems and install Jekyll:


</p>
<pre><code>gem update
gem install jekyll bundler
</code></pre>
<p>

Once complete you can now run your Jekyll projects locally through WSL! Nothing ground-breaking but still pretty helpful for first-time users. And best of all, at least I have a good reference point in the future if I ever run into this issue again!
</p>
<footer role="contentinfo">
    <h2>Menu Navigation</h2>
    <ul id="menu">
        <li><a href="/">Home</a></li>
        <li><a href="/projects">Projects</a></li>
        <li><a href="/uses">Uses</a></li>
        <li><a href="/wiki">Wiki</a></li>
        <li><a href="/resume">Resume</a></li>
        <li><a href="/colophon">Colophon</a></li>
        <li><a href="/now">Now</a></li>
        <li><a href="/donate">Donate</a></li>
        <li><a href="/atom.xml">RSS</a></li>
        <li><a href="#top">&uarr; Top of the page</a></li>
    </ul>
    <small>
        Built with <a href="https://git.sr.ht/~bt/barf">barf</a>. <br>
        Maintained with ♥ for the web. <br>
        Proud supporter of <a href="https://usefathom.com/ref/DKHJVX">Fathom</a> &amp; <a href="https://nextdns.io/?from=74d3p3h8">NextDNS</a>. <br>
        The content for this site is <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>.<br> The <a href="https://git.sr.ht/~bt/bt.ht">code for this site</a> is <a href="https://git.sr.ht/~bt/bt.ht/tree/master/item/LICENSE">MIT</a>.
    </small>
</footer>