Nodraak / cosmos-website

The COSMOS documentation website

Home Page:https://cosmosc2.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Development

  1. bundle install
  2. bundle exec jekyll serve

Building the v4 content

The v4 documentation is currently not re-built because it is assumed to be static. To enable building the v4 website:

  1. Set your path to include Ruby 2.5

    set PATH=C:\Ruby2.5\bin;%PATH%

  2. Ensure COSMOS4 is built:

    rake build

  3. Comment out the _config.yml exclude and keep_files section:

    exclude:
      - Gemfile
      - Rakefile
      #- _docs_v4/* # No longer automatically generate v4 content
    #keep_files:
      #- docs/v4 # Thus we keep the existing content
    
    
  4. Now you can run with bundle exec jekyll serve

Deployment

To deploy the website to github

  1. bundle exec rake build
  2. git commit -am "Build website"
  3. git push
  4. bundle exec rake deploy

About

The COSMOS documentation website

https://cosmosc2.com/

License:MIT License


Languages

Language:HTML 99.2%Language:SCSS 0.6%Language:CSS 0.2%Language:Ruby 0.1%