https://github.com/solidlabresearch/markdown-editor
https://github.com/solidlabresearch/markdown-editor
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/solidlabresearch/markdown-editor
- Owner: SolidLabResearch
- Created: 2023-04-25T06:47:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-08T13:18:43.000Z (almost 3 years ago)
- Last Synced: 2025-06-01T16:32:57.549Z (11 months ago)
- Language: JavaScript
- Homepage: https://solidlabresearch.github.io/markdown-editor/
- Size: 113 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown editor with GET/PUT support
This is a Markdown editor that allows users to load and store Markdown files via GET and PUT requests.
This works great with Solid and
the [Solid Authentication browser extension](https://github.com/KNowledgeOnWebScale/solid-authentication-browser-extension/).
## Features
- Load Markdown files via GET requests.
- Store Markdown files via PUT requests.
- Show WebID of user if user has logged in with the Solid Authentication browser extension.
- WebID and browser extension are not needed when working with public resources.
- Show urls of most recent files. The urls are stored in the browser storage.
## Usage
1. Install dependencies via `npm i`.
2. Start server via `npm start`.
3. Browse to .
## Screencast
You can watch a screencast of the editor [here](https://cloud.ilabt.imec.be/index.php/s/JcqFbRzNMFztC8D).
## Sequence diagram
You find a sequence diagram of how the app works with the browser extension [here](./sequence-diagram.png).
## Editor
We use [EasyMDE](https://github.com/Ionaru/easy-markdown-editor) as Markdown editor.
## License
This code is copyrighted by [Ghent University – imec](http://idlab.ugent.be/) and
released under the [MIT license](http://opensource.org/licenses/MIT).