Skip to content

Run Jekyll locally for GitHub docs

greg higgins edited this page Feb 25, 2023 · 1 revision

Ruby on Mac

  • Ruby is a pain to get working on Mac nice instructions here
  • webrick fails execute: bundle add webrick

Running local Jekyll site

cd docs
bundle exec jekyll serve

Valid output

Configuration file: /Users/greg/IdeaProjects/fluxtion/docs/_config.yml
To use retry middleware with Faraday v2.0+, install `faraday-retry` gem
            Source: /Users/greg/IdeaProjects/fluxtion/docs
       Destination: /Users/greg/IdeaProjects/fluxtion/docs/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
      Remote Theme: Using theme pmarsceill/just-the-docs
       Jekyll Feed: Generating feed for posts
                    done in 2.81 seconds.
 Auto-regeneration: enabled for '/Users/greg/IdeaProjects/fluxtion/docs'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.
Clone this wiki locally