It use the Phoenix Live View for live preview of the rendered markdown. The Monaco Editor is integrated for better writing experience.

To start your Phoenix server:

• Setup the project with mix setup
• Start Phoenix endpoint with mix phx.server

Now you can visit localhost:5000 from your browser.

Ready to run in production? Please check our deployment guides.

To create and start the docker image run:

docker-compose -f "docker-compose.yml" up -d --build

After the image is build and up you can reach the application with http://localhost:4000

To run the tests you need to set the environment variable STORAGE_PATH to a directory. The directory does not need to exist and will be deleted by the test.

On Windows:

$env:STORAGE_PATH="xxx"

Then you can run the tests with mix test

If you use VSCode then there is already a test task called run tests

This software is licensed under the MIT license.