README.md

The Slim Framework Website

This is the repository for the Slim website (slimframework.com).

Want to contribute?

If you spot any errors, typos, or missing information, please submit a pull request.

The documentation style guide

Unless otherwise stated, the documentation follows the AP Stylebook.

Are you a Microsoft Windows user

You need to make sure you have Ruby Devkit Installed (MSYS2).

Building and running the documentation locally

To run this site locally so that you can test your changes:

$ sudo gem install bundler
$ bundle install

Now, run the local Jekyll installation:

$ bundle exec jekyll serve

Then, browse to http://localhost:4000 in your browser of choice.

Editing the site's CSS

The CSS uses Less and is managed by grunt.

Install the tool chain:

$ npm install -g grunt-cli
$ npm install

To change any CSS, edit the appropriate files in assets\less and then run:

grunt

You can also run grunt watch to automatically rebuild when you make CSS changes.

Build instructions for deployment

bundle exec jekyll build

Update the Algolia search database

Ensure you set the environment variable ALGOLIA_API_KEY before running these commands. See algolia docs for more information.

bundle install
bundle exec jekyll algolia