[DOCS] Add documentations

JankariTech / web-app-presentation-viewer

ownCloud Web extension to view markdown presentation slides

Apache License 2.0

4 stars 1 forks source link

[DOCS] Add documentations #4

Closed grgprarup closed 2 months ago

grgprarup commented 8 months ago

[x] Project Setup docs in README.md https://github.com/JankariTech/web-app-presentation-viewer/pull/8
[x] Add docs for markdown file format
[x] Add needed documentation

koebel commented 8 months ago

README.md needs some proof reading... Make sure to spell at least ownCloud properly :)

koebel commented 8 months ago

In my understanding the current version only allows preview of presentation files, not creation or modification. Is that correct? If so, the sentence to create slide presentations directly from markdown files in the description of the extension in README.md can lead to miss-understanding of the features provided. To make it clearer write something like to preview slide presentations that were created in markdown files using the reveal.js syntax

koebel commented 7 months ago

I've added a 1 sentence description plus some keywords in "About" section of this repo. Please have a look.

S-Panta commented 2 months ago

Done https://github.com/JankariTech/web-app-presentation-viewer/pull/77