README.md

🖌 Docsify

Simple Docsify with Mermaid plug-in and example.

Updates

This image is regularly update with the latest release from the official docsify-cli image.

Whenever there is an update for the original docsify-cli npm an automatic pull request is opened to implement the update and I do my best to merge the updates quickly.

The workflow file for this can be found in .github/workflows/auto-build-container.yml

📥 Download

Docker Image

DockerHub

docker pull afreisinger/docsify:latest

GitHub Registry

docker pull ghcr.io/afreisinger/docsify:latest

Using Docker Image

Setup

# initilize docs folder using docsify
docker run --rm -v docs:/docs afreisinger/docsify init

Run

# using docker container
docker run --rm -v docs:/docs afreisinger/docsify serve

Optional Params

Optional parameters to pass to docsify

--livereload-port=PORT_HERE     livereload on PORT_HERE

Example

git clone https://github.com/afreisinger/docsify.git
cd docsify/
mv docs.sample docs
docker-compose up -d  #modify docker-compose if necessary

📖 Resources

For more info on docsify

• Read docsify documentation
• Find docsify source on github

📄 License

Apache License, Version 2.0 © 2024 afreisinger