https://github.com/justcoded/dockerize-docsify
Simple wrapper for docsifyjs based on nginx image
https://github.com/justcoded/dockerize-docsify
docker docsify
Last synced: 10 months ago
JSON representation
Simple wrapper for docsifyjs based on nginx image
- Host: GitHub
- URL: https://github.com/justcoded/dockerize-docsify
- Owner: justcoded
- Created: 2023-09-19T10:25:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T12:52:31.000Z (over 1 year ago)
- Last Synced: 2025-01-29T18:22:51.294Z (12 months ago)
- Topics: docker, docsify
- Language: CSS
- Homepage:
- Size: 2.06 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Docsify docker image
## About
This is docker image to fast start with docsify markdown docs viewer.
It's based on nginx docker image.
## Quick start
Just launch the container to see it in action
```
docker run --name docsify-example -d -p 8080:80 ghcr.io/justcoded/docsify:latest
```
Access the demo page on 127.0.0.1:8080.
## Display your docs
Just mount your docs folder to /usr/share/nginx/html/docs.
Special files you may want to create:
_sidebar.md - Left nav
_navbar.md - Top nav
## Docker compose example
```
---
version: '3.7'
services:
docsify:
image: ghcr.io/justcoded/docsify:latest
volumes:
- ./docs/:/usr/share/nginx/html/docs
ports:
- 8080:80
```
## Configurations
### Custom docsify config
If you want custom config you can override /usr/share/nginx/html/assets/docsify.conf.js with your mounted file.
Alternatively, you can set env variable with json to override the config:
```
...
environment:
OPT_DOCSIFY_CONF: "{subMaxLevel: 3}"
```
### Custom page title
To specify custom page title on page load you can use env variable:
```
...
environment:
OPT_INDEX_TITLE: My custom page title
```