Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jankaritech/web-app-presentation-viewer
ownCloud Web Presentation Viewer is an extension of ownCloud Web to create and share slide presentations rendered from MD files
https://github.com/jankaritech/web-app-presentation-viewer
frontend md owncloud owncloud-web reveal-js revealjs typescript vue vuejs
Last synced: 3 days ago
JSON representation
ownCloud Web Presentation Viewer is an extension of ownCloud Web to create and share slide presentations rendered from MD files
- Host: GitHub
- URL: https://github.com/jankaritech/web-app-presentation-viewer
- Owner: JankariTech
- License: apache-2.0
- Created: 2024-02-07T10:34:57.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-11T12:00:17.000Z (6 months ago)
- Last Synced: 2024-04-12T17:21:56.352Z (6 months ago)
- Topics: frontend, md, owncloud, owncloud-web, reveal-js, revealjs, typescript, vue, vuejs
- Language: Vue
- Homepage:
- Size: 146 KB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Markdown Presentation Viewer for ownCloud Web
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:
- create slide presentations directly from markdown files
- share the slides using public links
## Demonstration
- [Demonstation page](https://ocis.in-nepal.de/com.github.jankaritech.mdpresentation-viewer/public/phDIUqntYOMSfcE/presentation.md)
- Click on `Open in Presentation Viewer` to view the slides
## Supported oCIS and Web Versions
- [oCIS](https://github.com/owncloud/ocis) (>= 6.x.x)
- [Web](https://nodejs.org/en/) (>= 9.x.x)
## App Installation
> NOTE: Requires oCIS >= 6.0.0
1. Download the zip file from the [releases page](https://github.com/JankariTech/web-app-presentation-viewer/releases)
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
- [Node.js `v18`](https://nodejs.org/en/)
- [pnpm `v8`](https://pnpm.io/)
- [Docker Compose](https://docs.docker.com/compose/)
#### 1. Install dependencies:
```bash
pnpm install
```
#### 2. Build the extension
For development, build with watch.
```bash
pnpm build:w
```
#### 3. Load the extension
> NOTE: Requires oCIS >= 6.0.0
Run the oCIS server:
```bash
docker compose up
```
oCIS URL: [localhost:9200](https://localhost:9200)