Home

Awesome

⚠️ Notice This project is no longer maintained - read on #2


📦 Docsify

A Simple Docsify running env.

GitHub Workflow Status Docker Image Size (tag) Docker Pulls

<!-- `:latest` docker image is built every week on SUNDAY @ UTC 23:41 hrs --> <br>

📥 Download

Docker Image

DockerHub

docker pull sujaykumarh/docsify:latest

GitHub Registry

docker pull ghcr.io/sujaykumarh/docsify:latest
<br>

🛠️ Usage

Example setup

Example repo

git clone https://github.com/sujaykumarh/docsify-docker-example.git
<br>

Using Docker Image

setup

# initilize docs folder using docsify
docker run --rm -v docs:/docs ghcr.io/sujaykumarh/docsify init

Run

# using docker container
docker run --rm -v docs:/docs ghcr.io/sujaykumarh/docsify serve

Optional Params

Optional parameters to pass to docsify


--livereload-port=PORT_HERE     livereload on PORT_HERE

<br>

📖 Resources

For more info on docsify

<br>

📄 License

Apache License, Version 2.0 © 2021 sujaykumarh