https://github.com/hexagon6/docker-compose-nginx-markdown

Run Nginx with markdown
https://github.com/hexagon6/docker-compose-nginx-markdown

Last synced: about 1 month ago
JSON representation

Run Nginx with markdown

• Host: GitHub
• URL: https://github.com/hexagon6/docker-compose-nginx-markdown
• Owner: hexagon6
• Created: 2024-05-05T17:08:59.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-05T17:50:36.000Z (8 months ago)
• Last Synced: 2024-05-20T00:14:39.283Z (8 months ago)
• Language: Dockerfile
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docker compose nginx markdown

This repo provides a docker compose setup for running nginx with a markdown converter called [ngx_markdown_filter_module](https://github.com/ukarim/ngx_markdown_filter_module.git).

## usage

1. clone this repo

2. run `docker compose build`

3. run `docker compose up`

4. go to [http://localhost/](http://localhost/) to see test pages rendered as html. they can be found in `public/` of this repo

## features / non-features

- nginx is compiled without ssl, intended to be used behind a tls-terminated reverse proxy

- markdown (with github flavored markdown syntax) files with .md extension are converted to html with `ngx_markdown_filter_module`.

## running in production

1. modify the volume location inside compose.yml

2. run `docker compose up -d`

3. add .md files to your volume for pages

## why?

I wanted to run [https://nginx-extras.getpagespeed.com/modules/markdown/](https://nginx-extras.getpagespeed.com/modules/markdown/#build-with-cmark-gfm-tables-support) but did not find a compiled version for ubuntu / debian, as I like to use docker compose and went through all the compilation steps I thought maybe someone else could find this useful.

## possible improvements

- Docker image size optimization

  - remove downloaded apt cache after package installation

  - use separate build & run images