Before you can develop and contribute to the Charcoal website, you'll need to install the relevant packages and dependencies.
- If you're on a Mac, you'll need to install Developer Tools (or Xcode).
- In Terminal, run
xcode-select --install
- You may already have Xcode installed. Make sure it's up to date by running
softwareupdate --install -a
to install all updates.
- In Terminal, run
- Next, you'll need to install the Ruby dependencies:
gem install jekyll bundler
- If, for example, you already have
bundler
, you can just rungem install jekyll
- Finally, install the project-specific dependencies:
bundle install
- You can see what the dependencies are in Gemfile.rb.
You'll need to build the website based on the markdown files, then run the server that serves up the compiled website.
script/build --dev
- Download and process the Wiki pages
script/serve
- This runs the server that lets you preview what the website will look like once deployed.
- Using this script instead of
bundle exec jekyll serve
will make the server only rebuild changed pages and automatically reload open pages in the browser when rebuilding.