Acos API Documentation

This is the source for https://acosas.github.io/

Committing changes to this repo will affect the site.

Theme for Jekyll

This site is based on a theme from Tom Johnson
Site: Documentation Theme for Jekyll

Making changes

Download source

• Download the source

Install Ruby and Jekyll

Windows:

• Enable: Windows Subsystem for Linux , see: https://docs.microsoft.com/nb-no/windows/wsl/install-win10
• Install your linux flavour from Windows Store

Ruby

• Install Ruby on Ubuntu

sudo apt-get install ruby-full build-essential zlib1g-dev
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

gem install jekyll bundler

Update gems

bundle update    

Serve site

To build any pages from json run:

# Builds all pages based on json files in _data/swagger folder
./build_site.sh 

Add documentation

To add a swagger openapi json file to the site add the .json file to the _data/swagger/ folder. Add a unique name Run:

# from site root folder ./
./build_pages.sh

This will produce a [name]sidebar.yml file and files in ./pages/swagger folder named [name][path].md

In _config.yml file in the root add the newly created _sidebar.yml file to the list of sidebars:

sidebars: 
    - name: [name]_sidebar.yml
    ...
site_sidebars: 
    - name: [name]_sidebar.yml

Test and validate changes.

To publish site just push to git.

git push -u origin master

If remote is not added:

git remote add origin https://github.com/ACOSAS/acosas.github.io.git

To generate pages it is developed a gem for producing the files.
Source: github

Should maybe regiser acos on rubygems.org...