murky

KO | EN

gitlite — search

#react #ai #llm #go #machine-learning #rust #docker #windows #cli #awesome-list #pytorch #ios #openai #open-source

(★ 12)

Murky is a simple Markdown wiki written in Elixir.

murky Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![murky](https://github.com/lulabad/murky/blob/master/assets/static/images/murky.png)

# `Murky` is a file based Markdown wiki written in Elixir.

It use the [Phoenix Live View](https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html) for live preview of the rendered markdown. The [Monaco Editor](https://microsoft.github.io/monaco-editor/) is integrated for better writing experience.

## Usage

To start your Phoenix server:

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

Now you can visit [`localhost:5000`](http://localhost:5000) from your browser.

Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).

## Docker

To create and start the docker image run:

```sh
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](http://localhost:4000)

## Run tests

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:

```powershell
$env:STORAGE_PATH="xxx"
```

Then you can run the tests with `mix test`

If you use [VSCode](https://code.visualstudio.com/) then there is already a test task called `run tests`

## License

This software is licensed under [the MIT license](LICENSE).

murky

murky Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

murky

murky Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README