Markdown Presentation Viewer for ownCloud Web

A markdown presentation viewer for ownCloud web (the webUI of 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
• Click on Open in Presentation Viewer to view the slides

Supported oCIS and Web Versions

• oCIS (>= 6.x.x)
• Web (>= 9.x.x)

App Installation

NOTE: Requires oCIS >= 6.0.0

1. Download the zip file from the releases page

   For example: mdpresentation-viewer-x.x.x.zip

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

   Apps directory is set using the WEB_ASSET_APPS_PATH environment variable.

App Installation With oCIS Deployment

1. Copy deployments/mdpresentation-viewer.yml into the web_extensions subfolder of oCIS full deployment example.
2. Add MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml to the ## oCIS Web Extensions ## section of the .env file of your installation (file is located in deployments/examples/ocis_full) and append it to the COMPOSE_FILE variable.

   ## oCIS Web Extensions ##
   MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml
   
   COMPOSE_FILE=docker-compose.yml${...}${MDPRESENTATION_VIEWER:-}

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

oCIS URL: ocis.owncloud.test

See the docs.

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

Prerequisites

• Node.js v18
• pnpm v8
• Docker Compose

1. Install dependencies:

pnpm install

2. Build the extension

For development, build with watch.

pnpm build:w

3. Load the extension

NOTE: Requires oCIS >= 6.0.0

Run the oCIS server:

docker compose up

oCIS URL: localhost:9200