Skip to content

Commit

Permalink
Start jekyll documentation server on devenv up
Browse files Browse the repository at this point in the history
  • Loading branch information
erikrozendaal committed Jan 22, 2025
1 parent 6a33f31 commit ca9de47
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .envrc.example
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,8 @@
watch_file flake.nix
watch_file flake.lock
use flake . --no-pure-eval

# OPTIONAL: cConfigure with your personal access token to GitHub for
# additional data when looking at the local documentation server. See
# https://github.com/jekyll/github-metadata/blob/main/docs/authentication.md
#JEKYLL_GITHUB_TOKEN=
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ New to Sequent? [Getting Started](http://www.sequent.io/docs/getting-started.htm

## Contributing

Fork and send pull requests
Fork and send pull requests. You can setup a working development environment manually (see below) or by using https://devenv.sh with Nix. You can also
use https://direnv.net/ do setup your environment automatically, see `.envrc.example` for the minimal configuration.

Then just run `devenv up` to start Postgres and Jekyll. Run `devenv test` to (re-)create the databases and run the specs.

## Documentation

Expand Down
1 change: 1 addition & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@ GEM

PLATFORMS
arm64-darwin-23
arm64-darwin-24
x86_64-linux

DEPENDENCIES
Expand Down
7 changes: 7 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@
package = pkgs.ruby;
};

processes.jekyll.exec = ''
cd docs
bundle
bundle exec jekyll serve --livereload
'';


services.postgres = {
enable = true;
listen_addresses = "127.0.0.1";
Expand Down

0 comments on commit ca9de47

Please sign in to comment.