Overview
The Docsy Jekyll Theme is a starter template for a Docsy Jekyll theme, based on the Beautiful Docsy that renders with Hugo. This version is specifically designed for native deployment on GitHub Pages. It includes the original Apache License.
Features
- Customization: Edit configuration values and add pages easily.
- Navigation: Control the top navigation using the _data/navigation.yml file.
- Serve: Run the theme in a local server for development and testing.
- Docker Support: Run the theme as a container for development or production.
Installation
- Get the code: Clone the repository to your desired location.
- Customize: Edit the configuration values in the _config.yml file and add pages to the pages folder.
- Options: Most of the configuration values in the _config.yml file are self-explanatory. Refer to the getting started page for more details.
- Serve: Run the Jekyll server command to serve the theme locally. If you encounter an error, try adding the webrick gem to your Gemfile and run the command again.
- Run as a container: Install docker-ce and docker-compose, and use the provided docker-compose.yml file to run the theme as a container.
- Customize the docker-compose.yml file by specifying a particular version for Jekyll if desired.
- Remove the line mounting the bundles directory to the host in the docker-compose.yml file when deploying the container to production.
- Start Container: Use docker-compose to download the base container and bring up the server.
- Open http://localhost:4000 in your browser to view the server running.
- Note: Change the baseurl value in the _config.yml file to "" when running in local or production according to the requirement.
Summary
The Docsy Jekyll Theme is a versatile and customizable theme for creating documentation websites. It offers features such as easy customization, navigation control, and the option to run as a container. With comprehensive installation instructions, users can quickly set up and start using the theme for their documentation projects.
