Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.19 KB

README.md

File metadata and controls

39 lines (25 loc) · 1.19 KB

docsify (docsify)

Automatically serves ./docs workspace directory via 'docsify serve' in the background.

Example Usage

"features": {
    "ghcr.io/thediveo/devcontainer-features/docsify:0": {}
}

Options

Options Id Description Type Default Value
port TCP port serving the docsified documentation string 3300
livereload-port TCP port to receive live reload events from string 3301
docs-path workspace relative directory to serve from string docs

OS Support

Tested only with mcr.microsoft.com/devcontainers/base:ubuntu.

Docs Directory

If the directory configured in the docs-path option does not exist, it is automatically created when the devcontainer starts.

If the directory configured in the docs-path does not contain any index.html, both a starter index.html as well as README.md will be created.


Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.