Hello, welcome to the OSMT documentation site repo, here you'll find the steps needed to get you setup locally.
Latest Ruby and gems need to be installed first.
- If you do not have ruby locally do so by using Homebrew
brew install ruby
or rvm, your choice. - Once installed you will need to add it to your
$PATH
. Easiest way is to run this commandecho 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> "shell rc or profile of choice"
.
You need latest Ruby installed. Use ruby -v
to verify. Anything under 3.0.2 should be updated.
While on the project root directory
- Install bundler. Use gem to install it
gem install bundler
. - Next add webrick with bundler
bundle add webrick
. - Run
bundle install
to install the libraries. - to serve it you will need to run
bundle exec jekyll serve
.
We are currently deploying this static site to Github pages. To deploy is quite simple, just follow these steps:
- From the project repository go to
Settings
. - Click on
Pages
. - Under Source choose the branch you want the source code to deploy from and select
root
folder.
Once done, github will give you url to view the published site.