Sign inSign up

tiwutdev/asciidoc-server

By tiwutdev

Updated about 1 month ago

A lightweight web server that serves AsciiDoc files and live-reloads them as they change.

Image
Internet of things
Developer tools
Web servers
0

326

tiwutdev/asciidoc-server repository overview

Docker AsciiDoc Server

A lightweight, high-performance web server that serves AsciiDoc files and live-reloads them as they change. Packaged as a multi-architecture Docker container (arm64/x86_64) powered by Go and the official Ruby Asciidoctor engine.

Features

  • Live Reload: Edit .adoc files and watch the browser update instantly without manual refreshing.
  • Theming: Includes 5 beautiful default themes (default, dark, github, material, clean).
  • Native Asciidoctor: Uses the official Ruby engine for 100% standard compliance.
  • Multi-arch: Runs perfectly on x86_64 and arm64 (e.g., Apple Silicon).

Quick Start

  1. Start the server using Docker Compose:
    docker compose up -d
    
  2. Open your browser and navigate to http://localhost:8080.
  3. Edit the docs/index.adoc file and watch the live reload in action!

Configuration

version: '3.8'
services:
  server:
    build:
      context: .
      dockerfile: Dockerfile
    image: tiwutdev/asciidoc-server:latest
    container_name: adoc-server
    ports:
      - "8080:8080"
    environment:
      - PORT=8080
      - LIVERELOAD=true
      - THEME=default
    volumes:
      - ./docs:/docs
    restart: unless-stopped

You can configure the server using environment variables in the docker-compose.yml file:

VariableDefaultDescription
PORT8080The HTTP port the server will bind to.
LIVERELOADtrueEnables or disables the Server-Sent Events live-reload feature.
THEMEdefaultSet the AsciiDoc theme (default, dark, github, material, clean).

Tag summary

Content type

Image

Digest

sha256:8bf9901a3

Size

40.6 MB

Last updated

about 1 month ago

docker pull tiwutdev/asciidoc-server