Folder Structure Example

  [some location on your disk]
   ├── <doc-id>
   │     ├── hdocbook.json
   │     └── **/* (any content goes in here)
   ├── _inline/   
   │     └── **/* (any in-line content goes in here)
   ├── resources/   
   ├── hdocbook-project.json
   ├── package.json
   └── README.md

pdfGeneration property

The pdfGeneration property is an object containing two other properties:

• enable: Boolean true or false - specifies whether the book-build process should generate PDFs for page content
• exclude_paths: an array of strings, paths (fully qualified root relevant paths; supports wildcards) that should be excluded from the PDF-generation process

validation property

The validation property is an object that contains properties to control various aspects of book validation:

• exclude_links: an array of strings, containing links that should be excluded from the validation process. These could be example links that do not actually exist, or endpoints that are not available to the book-build and -publishing processes
• exclude_spellcheck: an array of objects, where document_path is the root relevant path to the document that should have additional validation exclusions applied, and words which is an array of strings, containing a list of words that should be excluded from the US - UK spellcheck validation
• exclude_h1_count: an array of strings, containing root-relevant paths of articles within the book that should be excluded from the H1 heading count validation

redirects property

The redirects property is an array of objects, where each object describes a permanent redirect. Once a book is published, one should avoid renaming a page without providing a server response that redirects permanently (301 or 308), or in the case of a delete, tells the caller that the resource is gone permanently (410).

To read how to configure these redirects, see Document Redirects.

Supported Product Families

Navigation Item Properties

Here is an example configuration, showing the file used to define this HDocBook:

{
    "docId": "hdoc-guide",
    "title": "Hornbill Docs Contributor Guide",
    "description": "Information about developing and publishing documentation on the Hornbill Docs (docs.hornbill.com) website",
    "publicSourceCode": "https://github.com/Hornbill-Docs/hdoc-guide",
    "version": "1.0.0",
    "navigation": {
        "items": [
            {
                "text": "Introduction",
                "expand": true,
                "items": [
                    {
                        "text": "Welcome",
                        "link": "hdoc-guide/index"
                    },
                    {
                        "text": "Concepts",
                        "expand": true,
                        "items": [
                            {
                                "text": "Overview",
                                "link": "hdoc-guide/overview",
                                "draft": true
                            },
                            {
                                "text": "HDocBook",
                                "link": "hdoc-guide/concepts/hdocbook"
                            },
                            {
                                "text": "Library",
                                "link": "hdoc-guide/concepts/library"
                            },
                            {
                                "text": "Publishing",
                                "link": "hdoc-guide/concepts/publishing"
                            }
                        ]
                    },
                    {
                        "text": "Getting Started",
                        "expand": true,
                        "items": [
                            {
                                "text": "1. Create a GitHub Account",
                                "link": "hdoc-guide/getting-started/github"
                            },
                            {
                                "text": "2. Install HDocBook Tools",
                                "link": "hdoc-guide/getting-started/tools"
                            },
                            {
                                "text": "3. Clone A Book Repository",
                                "link": "hdoc-guide/getting-started/clone-repo"
                            }
                        ]
                    },
                    {
                        "text": "HDocBook Reference",
                        "expand": true,
                        "items": [
                            {
                                "text": "Specification",
                                "link": "hdoc-guide/hdocbook/specification"
                            },
                            {
                                "text": "Markdown Syntax",
                                "link": "hdoc-guide/hdocbook/markdown"
                            },
                            {
                                "text": "Layout Templates",
                                "link": "hdoc-guide/hdocbook/layout-templates"
                            },
                            {
                                "text": "Frontmatter",
                                "link": "hdoc-guide/hdocbook/frontmatter"
                            },
                            {
                                "text": "Server Variables",
                                "link": "hdoc-guide/hdocbook/server-variables"
                            }
                        ]
                    },
                    {
                        "text": "Other Useful Resources",
                        "link": "hdoc-guide/additional-resources"
                    }
                ]
            }
        ]
    }
}

Audience

The Hornbill Docs publishing system is used to publish documentation to customers, as well as partners and internal Hornbill employees. The audiences are defined in the table below.