Marine

Contents writer application for track.

This application allows you to create all types of content supported by Track.

Installing / Getting started

Prerequisites

docker

Setting up

For windows users.

Take a look this Marine on Windows document first, please.

Start Marine

Run this command.

$ docker compose up -d

After the application started, you can access the app via http://localhost:39000

Stop Marine

Run this command.

$ docker compose down

Configuration

Contents directory

As default, Marine uses ./contents as contents directory. This directory is shared with docker container.

In the contents directory, all of the contents that meet with conditions below will be picked up by Marine and displayed as the contents list. (Recursively)

have book.yml or track.yml

Checkout your content repository in this directory.

How to update marine docker image

Marine is using a docker image published in DockerHub.

What you need to do to update the docker image is run this command.

$ docker pull givery/marine:latest

Contents Creation Guide

You can see all of documents under the ./docs.

Sample Contents

You can see all of sample contents under the ./contents.

Troubleshooting

See Troubleshooting Guide.

kmizu/marine