Skip to content

Commit

Permalink
Merge pull request #77 from JankariTech/docs/update-readme-images
Browse files Browse the repository at this point in the history
doc: update readme
  • Loading branch information
S-Panta authored Aug 29, 2024
2 parents 20dec19 + 0b35027 commit a3925fd
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Markdown Presentation Viewer for ownCloud Web

![cover photo](./images/cover-large.png)

A markdown presentation viewer for [ownCloud web](https://github.com/owncloud/web/) (the webUI of [oCIS](https://github.com/owncloud/ocis/)) using the [reveal.js](https://revealjs.com/) library.

It allows users to:
Expand All @@ -10,8 +12,7 @@ It allows users to:
## Demonstration

- [Demonstation page](https://ocis.in-nepal.de/files/link/public/bdSEsErbfGKoOIt?fileId=bdSEsErbfGKoOIt&files-public-link-view-mode=resource-table)
- Click on `Open in Text Editor` to view the markdown content.
- Click on `Open in Presentation Viewer` to view the rendered presentation.
- Click on `Open in Presentation Viewer` to view the slides

## Supported oCIS and Web Versions

Expand All @@ -24,12 +25,21 @@ It allows users to:
1. Download the zip file from the [releases page](https://github.com/JankariTech/web-app-presentation-viewer/releases)

For example: `mdpresentation-x.x.x.zip`
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.

## Creating Presentation

Please, refer to the [documentation](https://revealjs.com/markdown/) for more information about creating a presentation using markdown.

This app has the following default slide separators:

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

## Development

#### Prerequisites
Expand Down
Binary file added images/cover-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshots/0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshots/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshots/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a3925fd

Please sign in to comment.