rockben/docsify-server repository overview

⁠Docsify Server Docker

This project provides a pre-built Dockerized environment for Docsify, leveraging the official docsify-cli to serve your markdown documentation as an elegant website. The rockben/docsify-server image is automatically built with the latest version of docsify-cli.

⁠Features

• 📝 Effortless documentation: Write your docs in Markdown and let Docsify serve them with style.
• 🐳 Docker-powered: Pull the image and you're ready to go, no additional installation required.
• 🔄 Auto-update: The Docker image is built automatically from the official docsify-cli, keeping your environment up-to-date.

⁠Getting Started

⁠Prerequisites

Before you start, ensure you have Docker installed on your machine.

⁠Running the Docsify Server

1. Pull the Docker Image:

   Pull the rockben/docsify-server image from Docker Hub:

   docker pull rockben/docsify-server
   

   Copy

2. Organize Your Documentation:

   Place your markdown files in a local directory, e.g., ./docs.

3. Start the Docsify Server:

   Use docker-compose to start the server. Create a docker-compose.yml with the following content:

   version: "3.8"
   
   services:
     docsify:
       container_name: docsify-server
       image: ghcr.io/rockbenben/docsify-server:latest
       volumes:
         - ./docs:/docs
       ports:
         - "8080:3000"
       restart: unless-stopped
   

   Copy

   Run the container using:

   docker-compose up -d
   

   Copy

   Or quickly deploy with the following command:

   # ghcr.io
   docker run -d -p 8080:3000 --name docsify-server ghcr.io/rockbenben/docsify-server:latest
   
   # docker hub
   docker run -d -p 8080:3000 --name docsify-server rockben/docsify-server:latest
   

   Copy

4. Access Your Site:

   Your documentation site is now available at http://localhost:8080.