Testing github pages with remote theme locally

• just-the-docs

  17 6,981 8.4 SCSS

  A modern, high customizable, responsive Jekyll theme for documentation with built-in search.

  

  I am using github-pages with a remote theme (just-the-docs) to host one of my projects documentation. I wanted a way to test everything locally, without having to install anything on my machine. I found lots of resources, including this dev.to post, but none worked as expected. My biggest problems were:

• jekyll-docker

  2 993 0.0 Shell

  ⛴ Docker images, and CI builders for Jekyll.

  #!/usr/bin/env bash # using the official jekyll image, see https://github.com/envygeeks/jekyll-docker # runs on port 4000 mkdir -p ".bundles_cache" docker run --rm \ -v "$PWD:/srv/jekyll" \ -e BUNDLE_PATH="/srv/jekyll/.bundles_cache" \ -p 4000:4000 \ jekyll/builder:3.8 \ bash -c "gem install bundler && bundle install && bundle exec jekyll serve --host 0.0.0.0 --verbose --config _config.yml,_config_dev.yml"

• WorkOS

  workos.com

  sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• docker-compose-viz-mermaid

  2 29 5.7 Kotlin

  Generate beautiful visuals from docker-compose files. The mermaid graph can be exported to PNG, SVG, or edited directly in https://mermaid.live.

  The full example can be found here.

• rubygems

  211 3,545 9.9 Ruby

  Library packaging and distribution for Ruby.

  

  source "https://rubygems.org" # do NOT include the jekyll gem ! gem "github-pages", "~> 219", group: :jekyll_plugins gem "kramdown-parser-gfm"

• Puts Debuggerer

  3,144 91 5.5 Ruby

  Ruby library for improved puts debugging, automatically displaying bonus useful information such as source line number and source code.

  #!/usr/bin/env bash # using the official jekyll image, see https://github.com/envygeeks/jekyll-docker # runs on port 4000 mkdir -p ".bundles_cache" docker run --rm \ -v "$PWD:/srv/jekyll" \ -e BUNDLE_PATH="/srv/jekyll/.bundles_cache" \ -p 4000:4000 \ jekyll/builder:3.8 \ bash -c "gem install bundler && bundle install && bundle exec jekyll serve --host 0.0.0.0 --verbose --config _config.yml,_config_dev.yml"

• InfluxDB

  www.influxdata.com

  sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

Suggest a related project