Skip to content

Creating and updating Markdown files

Meis edited this page Nov 4, 2022 · 1 revision

Motivation

Table of Contents
To help users navigate our Documentation pages, we now display a Table of Contents (TOC). In order for the TOC to be correctly populated, Markdown files must conform to certain standards.

This guide uses the Filing FAQ file as a reference.
toc

Headings

The TOC is dynamically populated by the headings in our Markdown files. Only Section headings and sub-headings are included.

Note: please do not include special characters including ",\&*/'

Element Markdown Example In TOC
Document Title # HMDA Filing - Frequently Asked Questions Not Shown
Section Heading ## Account Registration image
Section Sub-heading ### What is my agency code? image
Clone this wiki locally