Giter Club home page Giter Club logo

civiform-docs's Introduction

CiviForm documentation

Welcome to the documentation for Civiform.

How to make changes to the docs

Updating a page

  • Updates should be made directly in the markdown files in ‘docs’ directory of the 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 Getting Started page of the Developer Guide, 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 syntax and follow Gitbook specific syntax below:

  • Drop-downs (as seen on on How does CiviForm work?): <details><summary>TITLE OF DROPDOWN</summary>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum</details>

  • Info box (as seen on CiviForm Admin Guide): {% hint style="success" %} Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. {% endhint %}

civiform-docs's People

Contributors

avritt-githubbot avatar avrittrohwer avatar azizova-leyla avatar bion avatar cassandralfernandes avatar cityofseattle-googlefellowship avatar goldblatt avatar gwendolyngoetz avatar jeanniefu avatar jessbumblebee avatar kmcnellis avatar leylacodes avatar michaelzetune avatar nbeloglazov avatar rasmi avatar reemaka avatar seanmalbert avatar shanemc-goog avatar sophiatareen avatar swatkat1 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.