https://github.com/totekuh/static-md-renderer

Markdown-based static sites - featuring live-reload, easy customization
https://github.com/totekuh/static-md-renderer

docker docker-compose markdown md static-site static-site-generator website website-template

Last synced: 3 days ago
JSON representation

Markdown-based static sites - featuring live-reload, easy customization

• Host: GitHub
• URL: https://github.com/totekuh/static-md-renderer
• Owner: totekuh
• Created: 2024-01-27T18:14:59.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-02-19T01:19:30.000Z (7 months ago)
• Last Synced: 2024-09-24T21:13:35.060Z (3 days ago)
• Topics: docker, docker-compose, markdown, md, static-site, static-site-generator, website, website-template
• Language: Python
• Homepage:
• Size: 856 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Static Markdown Renderer

This repository contains the setup for `static-md-renderer`, a Dockerized environment for a Jekyll blog. 

It's designed to rapidly deploy a Markdown-based static website, offering a live-reloading feature for real-time content updates.

## Prerequisites

Before starting, make sure you have the following installed on your system:

- Docker

- Docker Compose

## Setup and Running

**Clone the Repository** (if applicable):

   

```bash

git clone https://github.com/totekuh/static-md-renderer

cd static-md-renderer

```

    

**Environment Configuration**:

    

Modify `docker.env` to suit your environment settings, such as specifying the local folder for pages and the port number.

    

**Building and Running the Container**:

    

Use the provided `run.sh` script to build and start your Jekyll site:

```bash

./run.sh

```

    

This script executes docker-compose with the necessary parameters to set up the environment.

**Accessing the Site**:

    

Once the container is running, access your Jekyll site at `http://localhost:[HOST_PORT]`, where `[HOST_PORT]` is the port number specified in `docker.env`.

## Adding Content:

Place your Markdown files in the specified directory as configured in `docker.env` (the default folder is `./pages/` in the current running directory).