faraday/docs/README.md
Olle Jonsson a0c4a1cd03 Trivially edit docs/ README
...to push to the docs/ directory, to try to get it to build.
2021-04-14 08:31:48 +02:00

22 lines
514 B
Markdown

# Faraday Website
This is the root directory of the [Faraday Website][website].
If you want to apply changes to it, please test it locally using `Jekyll`.
Here is how:
```bash
# Navigate into the /docs folder
$ cd docs
# Install Jekyll dependencies, this bundle is different from Faraday's one.
$ bundle install
# Run the Jekyll server with the Faraday website
$ bundle exec jekyll serve
# The site will now be reachable at http://127.0.0.1:4000/faraday/
```
[website]: https://lostisland.github.io/faraday