Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdown improvements #2270

Merged
merged 1 commit into from
Jun 25, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,8 @@ Cats cross-compiles to both JVM and Javascript(JS). If you are not used to
working with cross-compiling builds, the first things that you will notice is that
builds:

* Will take longer: To build JVM only, just use the `catsJVM`, or `catsJS` for

JS only. And if you want the default project to be `catsJVM`, just copy the
* Will take longer: To build JVM only, just use the `catsJVM`, or `catsJS`
for JS only. And if you want the default project to be `catsJVM`, just copy the
file `scripts/sbtrc-JVM` to `.sbtrc` in the root directory.

* May run out of memory: We suggest you use
Expand Down Expand Up @@ -185,13 +184,13 @@ run `sbt docs/makeMicrosite`

### Previewing the site

1. Install jekyll locally, depending on your platform, you might do this with:
1. Install jekyll locally. Depending on your platform, you might do this with:

yum install jekyll
`yum install jekyll`

apt-get install ruby-full; gem install jekyll
`apt-get install ruby-full; gem install jekyll`

gem install jekyll
`gem install jekyll`

2. In a shell, navigate to the generated site directory in `docs/target/site`

Expand Down