opened 03:49PM - 31 Mar 18 UTC
closed 10:18AM - 17 May 19 UTC
feature
This is an issue that is well-suited for external contributors – let me know if …I can be of any help, either via this issue or via support@pretalx.com.
## What this is about
pretalx allows many fields to be filled in with markdown support. It would be great to offer an editor with a preview tab. Bonus points for an editor like this one here at GitHub, supporting adding markup via buttons for people not familiar with markdown.
## How to get started
First of all, leave a comment on this issue to make sure nobody else starts working on this issue at the same time!
Next, you need pretalx running locally on your machine. First, [fork](https://github.com/pretalx/pretalx/fork) the repository to your own GitHub account. Then clone it locally (or [set it as your remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/) if you already cloned it earlier)
Follow the [developer setup guide](https://docs.pretalx.org/en/latest/developer/setup.html), and then play around with pretalx a bit.
Have a look at the places impacting this issue. Look at the code responsible for the issues (searching for relevant words or files should help you find your way around). We have an explanation of our [code structure](https://docs.pretalx.org/en/latest/developer/concepts.html) and the actual [data models](https://docs.pretalx.org/en/latest/developer/interfaces/models.html).
## How to do this
You'll want to implement a custom widget in `pretalx/common/forms/widgets.py`, where you can also see examples. Please note that this should provide a safe fallback for users who block JavaScript execution.
Static files can be added in `pretalx/static/common/`, but should only be included in views with forms in the `cfp` and `agenda` parts of pretalx. In the `orga` app, you can include these parts in the `pretalx/orga/templates/orga/base.html` parent template, as basically every page in this area contains forms.
A challenge will be the proper inclusion of multi-language forms, so please make sure to test with events with a single active language and multiple active languages.
## Submit the PR
There are a number of tutorials on the Pull Request workflow online, for example this [short version](https://guides.github.com/introduction/flow/) by GitHub itself and this [more in-depth tutorial](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
Remember to provide documentation and tests, if applicable. Run the tests before opening your PR, including style checks. We have a [contribution guide](https://docs.pretalx.org/en/latest/developer/contributing.html), which ought to prove helpful at this stage.
