Skip to content

Commit

Permalink
Clean up the content in the README
Browse files Browse the repository at this point in the history
This is a small changed aimed at ensuring the content there is in line
with the other changes made to the documentation.
  • Loading branch information
settermjd committed Jan 25, 2024
1 parent 1d05b6d commit 31159fe
Showing 1 changed file with 30 additions and 19 deletions.
49 changes: 30 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
# Slim-Website
# The Slim Framework Website

This is the repository for the Slim website at www.slimframework.com.
This is the repository for the Slim website ([slimframework.com][slimframework-url]).

## Want to contribute?

## Contributing
If you spot any errors, typos, or missing information, please submit [a pull request][pr-url].

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][ap-stylebook-url].

### Are you a Microsoft Windows user

### Windows User
You need to make sure you have [Ruby Devkit Installed (MSYS2)](https://rubyinstaller.org/add-ons/devkit.html).

### Running Locally
### Building and running the documentation locally

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

```bash
$ sudo gem install bundler
$ bundle install
```

Now, run the local jekyll:
Now, run the local [Jekyll][jekyll-url] installation:

```bash
$ bundle exec jekyll serve
```

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

#### CSS
#### Editing the site's CSS

The CSS uses Less and is managed by `grunt`.

Expand All @@ -40,22 +45,28 @@ $ npm install
To change any CSS, edit the appropriate files in `assets\less` and then run:

```bash
$ grunt
grunt
```

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

### Build Instructions For Deployment
### Build instructions for deployment

```bash
$ bundle exec jekyll build
bundle exec jekyll build
```

### Update Algolia Search
Ensure you set the environment variable `ALGOLIA_API_KEY` before running these commands. See [algolia docs](https://community.algolia.com/jekyll-algolia/getting-started.html) for more information
### Update the Algolia search database

Ensure you set the environment variable `ALGOLIA_API_KEY` before running these commands.
See [algolia docs](https://community.algolia.com/jekyll-algolia/getting-started.html) for more information.

```bash
$ bundle install
$ bundle exec jekyll algolia
bundle install
bundle exec jekyll algolia
```

[ap-stylebook-url]: https://www.apstylebook.com
[jekyll-url]: https://jekyllrb.com
[pr-url]: https://github.com/slimphp/Slim-Website/compare
[slimframework-url]: https://slimframework.com

0 comments on commit 31159fe

Please sign in to comment.