README.md

Introduction to Aquifer

This is the wiki contains documentation for the Aquifer project.

• Aquifer GitHub org
• Aquifer core repository
• Aquifer npm module
• This wiki's repository

Table of Contents

• What is a 'Drush make workflow'?
• What is Aquifer?
• Quick-start guide
• Installation
• Scaffold system
  • Directory structure
  • Project API
• Build system
  • Build API

Contributing

Contributing to this wiki is painless. Everything is stored and served from the Aquifer wiki repository. All pages are stored in the /sections folder, and added to the SUMMARY.md file as markdown links in a bulleted list. Gitbook is used to compile the docs and create the browser-friendly pages, which is published on Github pages at docs.aquifer.io.

Process for submitting changes

• Fork the Aquifer wiki repository.
• Make your changes in a branch other than master or gh-pages.
• Submit a PR with your changes.

Using gitbook

This wiki uses gitbooks to compile the markdown files into a collection of browser-friendly pages. To compile the markdown:

• Install gitbook: npm install gitbook-cli -g.
• In the wiki directory, run gitbook install.
• To build the project, in the wiki directory, run gitbook build.
• If you would like to locally test the compiled output, run gitbook serve, and point your browser at http://localhost:4000.
• NOTE: Gitbooks will remove the CNAME file in the _book directory. Do not commit this change.