Giter Club home page Giter Club logo

ace-documentation's Introduction

Product thumbnail

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.

Rich in features

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.

Beautiful minimalist design

With a minimal design, the attention of users is focused on that which matters: your content.

Demo & documentation

The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo.

Installation

  • 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.

Resources

Reporting Issues

We use GitHub Issues as the official bug tracker for the Ace documentation. When reporting an issue, please follow the following guidelines:

  1. Make sure that you are using the latest version of Ace documentation.
  2. Provide us with reproducible steps for recreating the issue, in order for us to find the issue and fix is as soon as possible.
  3. Specify your browser and version of Ace.

Contributing to 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 commiting breaking changes.

Licensing

Useful links

Social Media

ace-documentation's People

Contributors

jhollowe avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.