Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Attribution and Thanks

Hornbill Docs is built substantially using open source tools and has drawn inspiration, guidance and ideas from the systems, projects and information made generally available to the open-source community. The Hornbill Docs project is standing on the shoulders of giants: the many individuals, teams and organizations who have contributed time, resources and knowhow to open-source projects to the benefit of everyone. We would like to attribute this project to the projects, individuals and organizations named below, from whom we have drawn inspiration, knowhow and software:

  • Microsoft Learn—a world-class project showing how to embrace an open-source philosophy to produce an outstanding documentation system. Hornbill Docs has drawn huge inspiration from this project, and made use of various open-source artifacts that Microsoft have made available to the community under liberal licensing agreements.
  • Vitepress—a really nice “instant up and running” example of how to create a static documentation site using Markdown and Node.js with a live-edit environment. Although Vitepress turned out not to be the right solution to build Hornbill Docs on, it provided the initial inspiration and kickstart for the Hornbill Docs project.
  • GitHub—a great source control ecosystem and tooling that makes community engagement, and therefore external contribution to Hornbill Docs at scale, possible.
  • Node.js—when development workflows are involved, Node.js and its many projects, libraries and tools are pretty amazing.
  • markdown-it
  • highlight.js
  • Vue.js
  • Express.js
  • others to follow…

We have been using a Wiki tool for the Hornbill Wiki for almost 10 years now, a very long time, but as our product range, number of customers and partner ecosystems have grown, the Hornbill Docs platform will be the foundation and standard for our future documentation strategy.

In This Document