mkdocs.yml

site_name: cfgov-refresh

repo_url: https://github.com/cfpb/cfgov-refresh

nav:
- Introduction: index.md
- Installation: installation.md
- Running this Project:
    - Running in a Virtual Environment: running-virtualenv.md
    - Running in Docker: running-docker.md
    - Debugging and Monitoring: debugging-monitoring.md
    - Artifacts and Deployment: deployment.md
- Pages and Components:
    - Atomic Structure and Design: atomic-structure.md
    - Creating and Editing Components: editing-components.md
    - Django and Wagtail Migrations: migrations.md
    - Editing the Mega Menu: mega-menu.md
    - Forms in Wagtail Page Context: forms-in-wagtail.md
    - Wagtail Pages: wagtail-pages.md
- Supporting Features:
    - Caching: caching.md
    - Feature Flags: feature-flags.md
    - Split Testing: split-testing.md
    - Translation: translation.md
- Testing:
    - Browser/Acceptance Testing: browser-acceptance-tests.md
    - JavaScript Unit Testing: javascript-unit-tests.md
    - Python Unit Testing: python-unit-tests.md
- Contributing:
    - Branching and Merging: branching-merging.md
    - Contributing to the Docs: contributing-docs.md
    - Related Projects: related-projects.md
    - Development Tips: development-tips.md
    - How We Use Travis CI: travis.md
- APIs and Data:
    - Ask CFPB: ask-cfpb.md
    - Consumer Complaints: consumer-complaint-database.md
    - Find a Housing Counselor Tool: housing-counselor-tool.md
    - HMDA Data: hmda.md
    - Website Feedback: website-feedback.md

theme:
    name: readthedocs
    custom_dir: docs/theme-overrides/ # @TODO: We may be able to remove this custom template when MkDocs 1.1 is released
extra_css:
    - css/overrides.css

markdown_extensions:
    - admonition
    - pymdownx.betterem
    - pymdownx.highlight
    - pymdownx.magiclink
    - pymdownx.superfences
    - pymdownx.tilde
    - tables
    - toc:
        permalink: "¶"