added steps for Troubleshooting Jekyll errors (#1907)

Shubham Bhardwaj · web-flow · commit a044321a4f2b · 2022-02-02T02:52:44.000Z
* added steps for Troubleshooting Jekyll errors

* typos and clarifications

(dident actually test github pages)
diff --git a/docs/content/getting-started/index.md b/docs/content/getting-started/index.md
@@ -94,6 +94,28 @@ Don't forget to add the compiled CSS to the `<head>` section of your page.
 ```html
 <link href="path/to/style.css" rel="stylesheet" />
 ```
+### Troubleshooting Jekyll errors
+
+Currently [jekyll-sass-converter](https://github.com/jekyll/jekyll-sass-converter) uses the [deprecated  `LibSass` library](https://github.com/jekyll/jekyll-sass-converter#sass-implementations). Due to this you might run into issues. One way to deal with this is to use an experimental version of `jekyll-sass-converter` which uses [dart sass](https://sass-lang.com/dart-sass).
+
+1. Add `jekyll-sass-converter` and `sass-embedded` to `Gemfile`:
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-sass-converter', github: 'jekyll/jekyll-sass-converter'
+  gem 'sass-embedded'
+end
+```
+2. Run `bundle install`
+```bash
+$ bundle install
+```
+3. Update your `_config.yml`:
+```yml
+sass:
+  implementation: sass-embedded
+```
+
+Since Github pages is currently [locked to version `1.5.2` of `jekyll-sass-converter`](https://pages.github.com/versions/). If you run into errors you should look into [using the built CSS](#using-primer-css-on-a-static-site).
 
 ## Using Primer CSS on a static site
 
