Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

Migrate to GitHub Pages #143

Closed
trentmwillis opened this issue Nov 8, 2017 · 3 comments
Closed

Migrate to GitHub Pages #143

trentmwillis opened this issue Nov 8, 2017 · 3 comments

Comments

@trentmwillis
Copy link
Member

The current structure of this repo makes it difficult for new contributors. They have to get an entire VM running just to properly view their changes. So, I would like to propose that we migrate to a Jekyll site hosted on GitHub Pages. We did this somewhat recently with the API documentation.

The benefits as I see them are:

  1. Easier for new contributors to get up and running
  2. Documentation can be mostly written in Markdown, which means it can also be viewed in the repo itself
  3. Less dependency on the jQuery infrastructure
  4. Due to 3, we'll have more control over the look and feel of the website
@jzaefferer
Copy link
Member

What's the story for searching Jekyll sites these days? Searching for "jekyll search" produces kinda random blog posts and tutorials. That's still my biggest gripe with static site generators...

@platinumazure
Copy link
Contributor

For what it's worth, ESLint leverages algolia for site searching. Might be worth checking it out.

@Krinkle
Copy link
Member

Krinkle commented May 1, 2018

For the record, this is now being worked on at #151

@Krinkle Krinkle closed this as completed May 1, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

4 participants