= Documentation

:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


The Apache Causeway website and documentation are written using link:https://antora.org/[Antora] and link:https://asciidoctor.org/[Asciidoc(tor)]:

* Antora is the static website generator

* _Asciidoc_ is a markup syntax and _Asciidoctor_ the tools to convert the markup into different formats.
+
HTML is the format generated by Antora, but other outputs such as PDF are also supported.

Details of installing Antora and building the website/documentation can be found xref:building-docs-and-website.adoc[here].

Some of the documentation is automatically generated from the code itself.
Details on these generators is described on the xref:tooling.adoc[tooling] page.



