sujaykumarh / docsify-docker

:green_book: Docsify Docker Image :whale2:

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

⚠️ 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


πŸ“₯ Download

Docker Image

DockerHub

docker pull sujaykumarh/docsify:latest

GitHub Registry

docker pull ghcr.io/sujaykumarh/docsify:latest

πŸ› οΈ Usage

Example setup

Example repo

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

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

πŸ“– Resources

For more info on docsify


πŸ“„ License

Apache License, Version 2.0 Β© 2021 sujaykumarh

About

:green_book: Docsify Docker Image :whale2:

License:Apache License 2.0


Languages

Language:Shell 64.7%Language:Dockerfile 35.3%