CiviForm documentation

This repository contains the documentation at docs.civiform.us.

To edit the civiform.us website, see the website directory.

How to make changes to the docs

Updating a page

• Updates should be made directly in the markdown files in docs directory of the civiform/docs GitHub repository.
• Anyone can click ‘Edit on GitHub’ for any page within the docs site, which will take you directly to the markdown file for that page on GitHub.
• For example, if you want to update the Glossary page, you should make edits to this markdown file on GitHub.
• Updates must be made via pull request.

Creating a new page

• To create a new page, find the appropriate section in GitHub to which you’d like to add the new page
• Select 'Add File' > 'Create New File.'
• Write your file in Markdown and submit via pull request.

Organizing the table of contents

• Updates to the sidebar and table of contents can be made in the SUMMARY.md file

Adding markdown

• Reference this guide on writing simple markdown.
• For more advanced formatting, see the Gitbook docs on
  • code blocks
  • expandable sections
  • hints
  • tabs
  • OpenAPI methods
  • ...and more!