Markdown Presentation Viewer for OpenCloud & ownCloud (oCIS)

A markdown presentation viewer for OpenCloud and oCIS using the reveal.js library.

It allows users to:

• create slide presentations directly from markdown files
• share the slides using public links

Demonstration

• Demonstation page OpenCloud
• Demonstation page oCIS
• Click on Open in Presentation Viewer to view the slides

Supported oCIS and Web Versions

• oCIS (>= 6.x.x) or OpenCloud (>= 2.0.0)

App Installation

1. Download the zip file from the releases page

   For example: mdpresentation-viewer-<server>-x.x.x.zip

2. Extract the zip file to the apps directory of the OpenCloud/oCIS server.

   Apps directory is set using the WEB_ASSET_APPS_PATH environment variable.

App Installation With OpenCloud or oCIS Deployment

1. Copy the yml file that corresponds with your server (OpenCloud or oCIS) from deployments/ into the web_extensions subfolder.
2. Add MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer-<your-server>.yml to the Web Extensions section of the .env file of your installation and append it to the COMPOSE_FILE variable.

   MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer-<your-server>.yml
   
   COMPOSE_FILE=docker-compose.yml${...}${MDPRESENTATION_VIEWER:-}

3. Run docker compose up to run the server with the extensions

Creating Presentation

Please, refer to the documentation for more information about creating a presentation using markdown.

This app has the following default slide separators:

• Horizontal separator: --- (← →)
• Vertical separator: -- (↓ ↑)

Development

[!IMPORTANT] When switching between OpenCloud and oCIS, make sure to clean the browser cache! [!CAUTION] Before commiting changes run make installOcis and make clean

Prerequisites

• Node.js v18
• pnpm v8
• Docker Compose
• jq

1. Install dependencies:

For OpenCloud:

make installOpencloud

For oCIS:

make installOcis

2. Build the extension

For development, build with watch.

pnpm build:w

3. Load the extension

Run the server with the extension:

For OpenCloud:

docker compose -f docker-compose-opencloud.yml up

For oCIS:

docker compose -f docker-compose-ocis.yml up

server URL: localhost:9200

Running e2e tests:

For oCIS:

pnpm run test:e2e <path_to_feature_file>

For OpenCloud:

TARGET_SERVER=opencloud pnpm run test:e2e <path_to_feature_file>

Building Docker Container

For OpenCloud:

docker build --build-arg server=Opencloud -t jankaritech/mdpresentation-viewer-opencloud:<version> .

For Ocis:

docker build --build-arg server=Ocis -t jankaritech/mdpresentation-viewer-ocis:<version> .