#193 setup for vuepress

docs/.vuepress/config.js

@@ -0,0 +1,58 @@
+module.exports = {
+  title: 'SiteFarm Seed',
+  description: 'SiteFarm Seed is a base profile for Drupal 8 meant for extending by a custom built sub-profile.\n',
+  themeConfig: {
+    lastUpdated: 'Last Updated',
+    repo: 'ucdavis/sitefarm_seed',
+    docsDir: 'docs',
+    docsBranch: '8.x-1.x',
+    editLinks: true,
+    nav: [
+      { text: 'Get Started', link: '/configuring_localhost' },
+      { text: 'Sub-profile Template', link: 'https://github.com/ucdavis/sitefarm-distro-template' },
+    ],
+    sidebar: [
+      ['/', 'Home'],
+      ['configuring_localhost', 'Local Development Setup'],
+      ['creating_subprofile', 'Create a Sub-Profile'],
+      ['testing', 'Tests'],
+      'best_practices',
+      'sitefarm_custom_modules',
+      {
+        title: 'Feature Modules',
+        children: [
+          ['sitefarm_features/sitefarm_core', 'Core'],
+          ['sitefarm_features/sitefarm_page_feature', 'Basic Page'],
+          ['sitefarm_features/sitefarm_article_feature', 'Articles'],
+          ['sitefarm_features/sitefarm_person_feature', 'Person'],
+          ['sitefarm_features/sitefarm_event_feature', 'Event'],
+          ['sitefarm_features/sitefarm_photo_gallery_feature', 'Photo Gallery'],
+          ['sitefarm_features/sitefarm_basic_block_feature', 'Basic Block'],
+          ['sitefarm_features/sitefarm_focal_link_feature', 'Focal Link'],
+          ['sitefarm_features/sitefarm_focus_box_feature', 'Focus Box'],
+          ['sitefarm_features/sitefarm_hero_banner_feature', 'Hero Banner'],
+          ['sitefarm_features/sitefarm_marketing_highlight_feature', 'Marketing Highlight'],
+          ['sitefarm_features/sitefarm_image_styles_feature', 'Image Styles'],
+          ['sitefarm_features/sitefarm_wysiwyg_feature', 'WYSIWYG'],
+        ]
+      },
+      {
+        title: 'New Config',
+        children: [
+          'adding_new_config',
+          'altering_config',
+          'adding-core-reference-field',
+          'overriding_image_styles',
+        ]
+      },
+      {
+        title: 'Libraries',
+        children: [
+          'libraries',
+          'adding_libraries',
+        ]
+      },
+
+    ]
+  }
+};

docs/README.md

@@ -1,27 +1,41 @@
-# Table of Contents
+---
+home: true
+actionText: Get Started →
+actionLink: /configuring_localhost
+features:
+- title: Sensible Defaults
+  details: It provides sensible defaults and features that most websites will need.
+- title: Test Coverage
+  details: SiteFarm Seed has complete test coverage with both PhpUnit and Behat.
+- title: Example Sub-Profile
+  details: An example template for using SiteFarm Seed with a sub-profile to kickstart your own distro.
+footer: GPU Licensed | Copyright © 2017-present Regents of the University of California
+---
 
-* [Local Development Setup](configuring_localhost.md)
-* [Creating a Sub Profile of SiteFarm Seed](creating_subprofile.md)
-* [Adding New Configuration in a Sub Profile](adding_new_config.md)
-  * [Altering Existing Config](altering_config.md)
-  * [Adding Core Reference Fields](adding-core-reference-field.md)
-  * [Overriding Image Styles](overriding_image_styles.md)
-* [SiteFarm Seed Custom Modules](sitefarm_custom_modules.md)
-* SiteFarm Seed Feature Modules
-  * [SiteFarm Core](sitefarm_features/sitefarm_core.md)
-  * [SiteFarm Article](sitefarm_features/sitefarm_article_feature.md)
-  * [SiteFarm Basic Block](sitefarm_features/sitefarm_basic_block_feature.md)
-  * [SiteFarm Event](sitefarm_features/sitefarm_event_feature.md)
-  * [SiteFarm Focal Link](sitefarm_features/sitefarm_focal_link_feature.md)
-  * [SiteFarm Focus Box](sitefarm_features/sitefarm_focus_box_feature.md)
-  * [SiteFarm Hero Banner](sitefarm_features/sitefarm_hero_banner_feature.md)
-  * [SiteFarm Image Styles](sitefarm_features/sitefarm_image_styles_feature.md)
-  * [SiteFarm Marketing Highlight](sitefarm_features/sitefarm_marketing_highlight_feature.md)
-  * [SiteFarm Page](sitefarm_features/sitefarm_page_feature.md)
-  * [SiteFarm Person](sitefarm_features/sitefarm_person_feature.md)
-  * [SiteFarm Photo Gallery](sitefarm_features/sitefarm_photo_gallery_feature.md	)
-  * [SiteFarm WYSIWYG](sitefarm_features/sitefarm_wysiwyg_feature.md)
-* [Third-party Libraries](libraries.md)
-  * [Adding New Libraries](adding_libraries.md)
-* [Tests](testing.md)
-* [Best Practices](best_practices.md)
+## Features
+>FYI, the following links show fully themed components. SiteFarm Seed does **not**
+include any theming so that you can implement theming however you need something to look.
+1. **Sensible Defaults:** We did the tedious work that most websites need so you don't have to
+2. **Content Types:** 
+[Basic Page](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=templates-basic-page), 
+[Article](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=templates-article),
+[Event](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=templates-event),
+[Person](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=templates-person),
+& [Photo Gallery](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=templates-photo-gallery)
+3. **Block Types:** 
+Basic Block, 
+[Focal Link](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=molecules-focal-link), 
+[Focus Box](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=molecules-focus-box), 
+[Hero Banner](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=organisms-hero-banner), 
+[Marketing Highlight](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=molecules-marketing-highlight), 
+& [Marketing Highlight - Horizontal](http://ucd-one-patternlab.s3-website-us-west-1.amazonaws.com/?p=molecules-marketing-highlight-horizontal)
+4. **User Roles and Permissions:** Contributor, Editor, Site Manager, Site Builder, & Administrator
+5. **Image Styles:** Pre-built images styles are ready to be overridden to match a custom theme
+6. **Views:** Dozens of Views create blocks and pages ready for content
+7. **Polished:** Lots of Drupal 8's rough edges have been smoothed out for regular day-to-day users
+
+## Example Sub-Profile template
+An example template for using SiteFarm Seed with a sub-profile can be found on github.
+[https://github.com/ucdavis/SiteFarm-distro-template](https://github.com/ucdavis/SiteFarm-distro-template)
+
+[Composer](https://getcomposer.org/) is a requirement.

docs/adding-core-reference-field.md

@@ -4,7 +4,7 @@ Sitefarm Seed already provides base fields for Entity References to core content
 types. This means that by reusing these existing fields all that is needed is
 config for field instances.
 
-![Screenshot of reusing entity reference dropdown](images/reuse-entity-reference-fields.png)
+![Screenshot of reusing entity reference dropdown](./images/reuse-entity-reference-fields.png)
 
 ## Example: Adding a Reference field to Photo Galleries or Persons
 
@@ -20,7 +20,7 @@ Second, add config files for field instances and node form display.
 
 **examples:** `modules/features/sitefarm_article/override_examples/add_reference_fields/`
 
-![Screenshot of file structure to example config files](images/reference-config-examples.png)
+![Screenshot of file structure to example config files](./images/reference-config-examples.png)
 
 The `core.entity_form_display.node.sf_article.default.yml` adds both of the
 new field instances to the edit form so that an editor can add references to the
@@ -31,4 +31,4 @@ display. This is intended so that the content can be displayed in blocks.
 
 Creating an article `/node/add/sf_article` will now show the new fields.
 
-![Screenshot of Article add form with new reference fields](images/form-showing-new-reference-fields.png)
+![Screenshot of Article add form with new reference fields](./images/form-showing-new-reference-fields.png)

docs/adding_new_config.md

@@ -15,7 +15,7 @@ than a bundle in a Feature.
 To export a single yaml file of configuration, go to the Single Config Export
 page. User 1 has a shortcut to this page in their toolbar.
 
-![Screenshot of toolbar shortcut to Simple Config Export page](images/single-config-export-shortcut.png)
+![Screenshot of toolbar shortcut to Simple Config Export page](./images/single-config-export-shortcut.png)
 
 Choose the configuration type and name. Then copy the configuration and paste it
 into a new yaml file named based on the "Filename" given at the bottom of the

docs/overriding_image_styles.md

@@ -13,7 +13,7 @@ errors occur when installing a site.
 The second half of the solution is to have developers copy each of the image
 style config files into their default theme's `config/install` directory.
 
-![Screenshot of file structure to image style config files](images/image-style-config-directory.png)
+![Screenshot of file structure to image style config files](./images/image-style-config-directory.png)
 
 ## How it works
 

docs/sitefarm_features/sitefarm_event_feature.md

@@ -35,7 +35,7 @@ To provide Event content type and related configuration. Create an event which w
 * Pathauto pattern for Event content type
 
 ## Custom module code included
-* Plugin implementation of the 'Merge' formatter for 'daterange' fields: This formatter renders the data range using <time> elements, with configurable options for showing the day name and time.
+* Plugin implementation of the 'Merge' formatter for 'daterange' fields: This formatter renders the data range using `<time>` elements, with configurable options for showing the day name and time.
 * Form alters for moving some fields to the advanced tabs. 
 * Form modification for the date field to make format more usable. 
 * Form modification of the validation of form to handle to better date formatting.