Deploy Docsy inside a Docker container
We provide a Docker image that you can use to run and test your Docsy site locally, without having to install all Docsy’s dependencies.
Install the prerequisites
The installation may require you to reboot your computer for the changes to take effect.
Create your repository from the docsy-example template
The docsy-example repository provides a basic site structure that you can use as starting point to create your own documentation.
Download the code to your local machine by cloning your newly created repository.
Change your working directory to the newly created folder:
Build and run the container
The docsy-example repository includes a Dockerfile that you can use to run your site.
Build the docker image:
Run the built image:
Open the address
http://localhost:1313in your web browser to load the docsy-example homepage. You can now make changes to the source files, those changes will be live-reloaded in your browser.
To cleanup your system and delete the container image follow the next steps.
Stop Docker Compose with Ctrl + C.
Remove the produced images
- Learn about basic setup and configurations for Docsy.
- Add content and customize your site
- Publish your site.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.