diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..29949d465 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +/_site +/Gemfile.lock diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..5b4694d54 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,28 @@ +source "https://rubygems.org" + +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +gem "jekyll", "~> 3.8.5" + +# This is the default theme for new Jekyll sites. You may change this to anything you like. +# gem "minima", "~> 2.0" +gem "just-the-docs" + +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "github-pages" +# gem "jekyll-feed", "~> 0.6" +end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.0" if Gem.win_platform? + diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..4145394fe --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,38 @@ +title: enqueue-dev +description: A Jekyll theme for documentation +baseurl: "/enqueue-dev" # the subpath of your site, e.g. /blog +url: "" # the base hostname & protocol for your site, e.g. http://example.com + +permalink: pretty +exclude: + - "node_modules/" + - "*.gemspec" + - "*.gem" + - "Gemfile" + - "Gemfile.lock" + - "package.json" + - "package-lock.json" + - "script/" + - "LICENSE.txt" + - "lib/" + - "bin/" + - "README.md" + - "Rakefile" + +markdown: kramdown + +# Enable or disable the site search +search_enabled: true + +# Aux links for the upper right navigation +aux_links: + "enqueue-dev on GitHub": + - "//github.com/php-enqueue/enqueue-dev" + +# Color scheme currently only supports "dark" or nil (default) +color_scheme: nil + +remote_theme: pmarsceill/just-the-docs + +plugins: + - jekyll-seo-tag diff --git a/docs/_includes/nav.html b/docs/_includes/nav.html new file mode 100644 index 000000000..fa2492acc --- /dev/null +++ b/docs/_includes/nav.html @@ -0,0 +1,62 @@ + diff --git a/docs/index.md b/docs/index.md index 521e642fa..6fda30bee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,11 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: default +title: Index +--- +

Supporting Enqueue

Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider: @@ -37,7 +45,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made * [Job queue](#job-queue) - [Run unique job](job_queue/run_unique_job.md) - [Run sub job(s)](job_queue/run_sub_job.md) -* [EnqueueBundle (Symfony)](#enqueue-bundle-symfony). +* [EnqueueBundle (Symfony)](#enqueue-bundle-symfony). - [Quick tour](bundle/quick_tour.md) - [Config reference](bundle/config_reference.md) - [Cli commands](bundle/cli_commands.md) @@ -49,7 +57,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made - [Consumption extension](bundle/consumption_extension.md) - [Production settings](bundle/production_settings.md) - [Debugging](bundle/debugging.md) - - [Functional testing](bundle/functional_testing.md) + - [Functional testing](bundle/functional_testing.md) * [Laravel](#laravel) - [Quick tour](laravel/quick_tour.md) - [Queues](laravel/queues.md) @@ -91,3 +99,12 @@ Enqueue is an MIT-licensed open source project with its ongoing development made * [Yii PHP Framework has adopted AMQP Interop.](https://blog.forma-pro.com/yii-php-framework-has-adopted-amqp-interop-85ab47c9869f) * [(En)queue Symfony console commands](http://tech.yappa.be/enqueue-symfony-console-commands) * [From RabbitMq to PhpEnqueue via Symfony Messenger](https://medium.com/@stefanoalletti_40357/from-rabbitmq-to-phpenqueue-via-symfony-messenger-b8260d0e506c) + +## Contributing to this documentation + +To run this documentation locally, you can either create Jekyll environment on your local computer or use docker container. +To run docker container you can use a command from repository root directory: +```shell +docker run -p 4000:4000 --rm --volume="${PWD}/docs:/srv/jekyll" -it jekyll/jekyll jekyll serve --watch +``` +Documentation will then be available for you on http://localhost:4000/ once build completes and rebuild automatically on changes.