AppBuilder Docs

Documentation for CruGlobal/app_builder.

This includes both user (creating apps) and developer docs.

View on GitHub Pages: https://CruGlobal.github.io/appbuilder_docs/

Adding documentation

docs/<new_documentation_name>

---
parent: <'title' of parent: ex 'Develop'>
title: <New Documentation Name>
description: This is new documentation that helps with work
category: <Look for 'is-category' ex: 'develop'>
---

Building and previewing this documentation locally

Assuming Jekyll and Bundler are installed on your computer:

1. Change your working directory to the root directory of your site.

2. Run bundle install.

3. Run bundle exec jekyll serve to build your site and preview it at localhost:4000.

   The built site is stored in the directory _site.

Customization

Browse our documentation to learn more about how to use this theme.

Copy the template files

1. Create a .github/workflows directory at your project root if your repo doesn't already have one. Copy the pages.yml file into this directory. GitHub Actions searches this directory for workflow files.

2. Create a docs directory at your project root and copy all remaining template files into this directory.

Licensing and Attribution

This repository is licensed under the MIT License. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!

The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party starter workflows. A copy of their MIT License is available in actions/starter-workflows.

---