Content

The contents of the Lucee documentation is our number one priority. This chapter deals with how the documentation content is organised and written and should provide a thorough reference for anyone wishing to contribute to the content of the docs.

Overview

The documentation system is largely based on the Grav static CMS. This system uses folders to represent pages, and markdown files within those folders to provide the page content.

All of the source files for this documentation can be found in the /docs folder of the public repository; i.e. https://github.com/lucee/lucee-docs/tree/master/docs

For more information on how the folder structure and various page types work, see Documentation structure.

Markdown

The system uses markdown files to provide the bulk of the documentation.

In addition to plain markdown, we are also using the popular YAML front matter format to provide additional meta data for our pages (such as category tagging) and Python Pygments to provide syntax highlighting.

For more information on our "LuceeDocs-flavoured" Markdown, see LuceeDocs-flavoured Markdown.

Reference pages

Documentation pages that provide pure reference material (i.e. function and tag pages) use a mixture of markdown files and metadata from the Lucee source code itself to produce a final output.

This allows us to provide accurate and up to date reference material while also giving the community the ability to enhance the editorial content with code examples, better descriptions and cross-references.

For more information, see Reference pages.