The help site for Form.io
JavaScript CSS HTML Java Ruby Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_books Move integrations to own book and working on offline and auth. Mar 15, 2018
_chapters Adding better Minio documentation. Aug 15, 2018
_includes Language update Apr 4, 2018
_layouts Handle 404's and Added Select Filtering Guide Apr 18, 2018
_paragraphs Adding better Minio documentation. Aug 15, 2018
_sections/tutorials Cleaning up documentation. Mar 15, 2018
api Handle 404's and Added Select Filtering Guide Apr 18, 2018
assets Adding better Minio documentation. Aug 15, 2018
examples/conditional-fields Updating to use classes. Oct 6, 2015
howitworks Removed duplicate piece of presentation. Jan 13, 2016
integrations Restructured help docs and added walkthrough. Jun 4, 2016
start Updating the start guide and added a how it works guide. Jan 13, 2016
templates Add Service Tracker app, remove Movie App and reorder apps. Feb 16, 2016
.bowerrc Adding bower dependencies and form rendering. Aug 24, 2015
.gitignore Adding deploy mechansim for howitworks. Jan 13, 2016
404.html Handle 404's and Added Select Filtering Guide Apr 18, 2018
Gemfile Add basic structure of the site. Jul 6, 2015
Gemfile.lock Update dependencies. Mar 14, 2018
README.md Updating developer docs so that the relative links dont break prod an… Sep 22, 2016
_config.dev.yml Fixed the configs to support multiple stages. Feb 4, 2017
_config.prod.yml Fixed the configs to support multiple stages. Feb 4, 2017
_config.test.yml Fixed the configs to support multiple stages. Feb 4, 2017
_config.yml Fix home page links. Mar 15, 2018
bower.json Angular 4 Walk-Through Added Feb 27, 2018
contact.html Support and Contact Routing May 2, 2018
form.html Merge branch 'gh-pages' of https://github.com/formio/help.form.io int… Aug 28, 2015
gulpfile.js Image Update Feb 27, 2018
index.md Fix home page links. Mar 15, 2018
package-lock.json Adding okta integration. Jun 12, 2018
package.json Angular 4 Walk-Through Added Feb 27, 2018
project.html Language Update Apr 2, 2018
react.html Bump to rebuild. Feb 17, 2016
robots.txt Finish up core setup of site. Jul 6, 2015
support.html Support and Contact Routing May 2, 2018
thankyou.html Support and Contact Routing May 2, 2018

README.md

https://help.form.io documentation for form.io.

This repository is used to generate the documentation section of the form.io website. It is generated using jekyll. Feel free to update and change it using pull requests.

Testing locally

You will need jekyll installed and running to generate a local copy for testing.

  • ruby --version Ensure that you have at least version 2.0.0
  • gem install bundler Install bundler if you don't already have it.
  • bundle install Install this project's dependencies.

Running Jekyll

To run jekyll server locally, use the following commands.

  • bundle exec jekyll serve --config _config.dev.yml,_config.yml to run the server.
  • Open your browser and go to http://localhost:4000.

Editing Books

Books are the top level organization of content on the site. You can edit the name, summary and weight of a book by editing the file in the _books folder.

Editing Chapters

Chapters are the second level organization of content on the site. Chapters can have html at the top of them and a title. Chapters are in the _chapters folder and are grouped in folders based on the book name. These sub folders are only for organizing the content for ease of editing. Which book they are in depends on the Front Matter Variable "book".

Editing Paragraphs

Paragraphs are the third level organization of content on the site. Paragraphs can have html at the top of them and a title. Paragraphs are in the _paragraphs folder and are grouped by sub folders by book and chapter.