https://github.com/cknoll/markpad
markdown preview for etherpads
https://github.com/cknoll/markpad
Last synced: about 2 months ago
JSON representation
markdown preview for etherpads
- Host: GitHub
- URL: https://github.com/cknoll/markpad
- Owner: cknoll
- License: agpl-3.0
- Created: 2022-01-16T16:16:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-05T14:05:53.000Z (about 3 years ago)
- Last Synced: 2025-01-19T17:15:57.542Z (3 months ago)
- Language: Python
- Size: 86.9 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING.agpl3
Awesome Lists containing this project
- awesome-starred - cknoll/markpad - markdown preview for etherpads (others)
README
[](https://github.com/psf/black)
[](https://circleci.com/gh/cknoll/markpad/tree/main)
# About markpad
markpad is a simple web application to display the content of etherpads interpreted as markdown source. It thus allows to combine the power of etherpads (author-colors, simple installation, variety of plugins, ...) with the aesthetics of markdown rendering.
markpad is free software and hosted on [codeberg](https://codeberg.org/cknoll/markpad) and [github](https://github.com/cknoll/markpad).
# Local Testing Deployment
- Clone the repo
- Activate an appropriate environment (venv, conda)
- Run `pip install -r requirements.txt`
- Create your configuration file (`config-production.ini`) from `deployment/config-example.ini`.
- Initialize the database:
- `python manage.py makemigratins`
- `python manage.py migrate`
- Run the unittests with `python manage.py test`
- Start the test server with `python manage.py runserver`
# Deployment on Remote Server
`deployment/deploy.py` is taylored towards deployment on [uberspace.de](https://uberspace.de).
See: [deployment/README.md](deployment/README.md).