Create beautiful documentation for your projects with Ace for Hugo. Powered by Bootstrap and SASS, featuring must-have features such as syntax highlighting, copy-able code blocks, full search, a responsive layout and the power of Markdown to create your content.
Writing documentation has never been so easy.
Ace offers a variety of custom components and features which are a must-have for building project documentation. Code blocks are enriched with syntax highlighting and a copy button, allowing for your users to easily read your code and copy it into their project. Furthermore, a special version of the code block renders the HTML content in both the code block and on the page, giving your users a preview of what the code looks like.
Other shortcodes allow you to use Bootstrap components in your content, such as alerts, buttons, panels, collapse elements and more.
Full search allows your users to quickly find the content they require, and a responsive design makes your documentation available on both desktop and mobile devices.
With a minimal design, the attention of users is focused on that which matters: your content.
The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo.
- Download from GitHub
- Clone the repo
git clone https://github.com/vantagedesign/ace-documentation.git
Note: this theme only works with Hugo's extended version, due to the SCSS compile functionality.
We use GitHub Issues as the official bug tracker for the Ace documentation. When reporting an issue, please follow the following guidelines:
- Make sure that you are using the latest version of Ace documentation.
- Provide us with reproducible steps for recreating the issue, in order for us to find the issue and fix is as soon as possible.
- Specify your browser and version of Ace.
Contributions are highly appreciated and may be done by reporting issues with new feature suggestions or bug fixes, or by making pull requests. We'll try our best to get those sorted as soon as possible.
Please make pull requests to the dev branch. Make sure you're always running the latest version of Ace and that you are not committing breaking changes.
- Copyright 2020 [Vantage Design]
- Licensed under MIT (https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE.md)
- Facebook: https://www.facebook.com/vantagedesignofficial
- Instagram: https://www.instagram.com/vantagedesignofficial
This project is tested with BrowserStack.