This repository contains the source for our Sonatype Open Source Community Handbook. The published version can be viewed here.
This project is based from Docsy for Hugo.
You'll need the following tools installed locally for development:
- Hugo Extended (>=0.128.0)
- NPM
You can find out more about how to install Hugo for your environment in our Getting started guide.
Ensure npm install has been run - this ensures PostCSS is installed.
Once you've made your working copy of the site repo, from the repo root folder, run:
hugo serverYou can run docsy-example inside a Docker container,
the container runs with a volume bound to the docsy-example folder. This
approach doesn't require you to install any dependencies other than
Docker Desktop on Windows and
Mac, and Docker Compose on Linux.
-
Build the docker image
docker-compose build
-
Run the built image
docker-compose up
NOTE: You can run both commands at once with
docker-compose up --build. -
Verify that the service is working.
Open your web browser and type
http://localhost:1313in your navigation bar, This opens a local instance of the docsy-example homepage. You can now make changes to the docsy example and those changes will immediately show up in your browser after you save.
See CONTRIBUTING.md for details.
Remember:
This project is part of the Sonatype Nexus Community organization, which is not officially supported by Sonatype. Please review the latest pull requests, issues, and commits to understand this project's readiness for contribution and use.
- File suggestions and requests on this repo through GitHub Issues, so that the community can pitch in
- Use or contribute to this project according to your organization's policies and your own risk tolerance
- Don't file Sonatype support tickets related to this project— it won't reach the right people that way
Last but not least of all - have fun!