Skip to content

Commit

Permalink
Docs updating
Browse files Browse the repository at this point in the history
  • Loading branch information
thejimbirch committed Dec 26, 2024
1 parent 4458f47 commit bd632f2
Show file tree
Hide file tree
Showing 17 changed files with 175 additions and 173 deletions.
2 changes: 2 additions & 0 deletions .archbee.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
root: ./docs
structure:
summary: summary.md
readme: index.md
assets: assets
publishSpace: true
21 changes: 0 additions & 21 deletions docs/1-introduction.md

This file was deleted.

127 changes: 0 additions & 127 deletions docs/2-content-types.md

This file was deleted.

File renamed without changes.
47 changes: 47 additions & 0 deletions docs/content-types-event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

# Event content type

The event content types comes with the following fields:

- **Title:** The page title also used for the SEO page title
- **Description:** Used on the teaser display as well as the SEO meta description
- **Featured Image:** Used at the top of the page as a header as well as the card image on the teaser display
- **Overlay:** Changes the overlay over the image and the text color of the header and summary text
Options:
- Light - 90%
- Light - 75%
- Light - 50%
- Light - 25%
- Dark - 90%
- Dark - 75%
- Dark - 50%
- Dark - 25%
- **Header Position:** Places the title and description in the header section
Options:
- Top
- Middle
- Bottom
- **Hide Header Section:** Used to hide the page title and image and summary so that paragraphs can be used instead to place content
- **Date**
- **Attendance Mode**
Options:
- In Person
- Online
- Mixed
- **Availability**
Options:
- In Stock
- Sold Out
- Pre Order
- **Location**
- **Register LInk**
- **Category**
- **Cost**
- **Currency**
- **Components**
- **Body**
- **SEO Page Title:** Optional field to override the page title displayed for Search Engines and Social Media
- **SEO Image:** Optional field to override the Image displayed for Search Engines and Social Media
- **SEO Description:** Optional field to override the page description displayed for Search Engines and Social Media
- **Robots meta tag:** Optional field to add no-index or no-follow if the user prefers to hide pages from the search engines.
38 changes: 38 additions & 0 deletions docs/content-types-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

# Page content type

[![Screenshot](assets/images/create-page.gif)](https://www.loom.com/share/4c4c15d3730f43f3b5409cbc707298f9)

[Adding Content and Styling to a Page - Watch Video](https://www.loom.com/share/4c4c15d3730f43f3b5409cbc707298f9)

The page content types comes with the following fields:

- **Title:** The page title also used for the SEO page title
- **Description:** Used on the teaser display as well as the SEO meta description
- **Featured Image:** Used at the top of the page as a header as well as the card image on the teaser display
- **Overlay:** Changes the overlay over the image and the text color of the header and summary text.
Options:
- Light - 90%
- Light - 75%
- Light - 50%
- Light - 25%
- Dark - 90%
- Dark - 75%
- Dark - 50%
- Dark - 25%
- **Header Position:** Places the title and description in the header section
Options:
- Top
- Middle
- Bottom
- **Hide Header Section:** Used to hide the page title and image and summary so that paragraphs can be used instead to place content
- **Author**
- **Author URL**
- **External Source**
- **Components:** All available components that are outlined below.
- **Relationships:** Used to add related posts
- **SEO Page Title:** Optional field to override the page title displayed for Search Engines and Social Media
- **SEO Image:** Optional field to override the Image displayed for Search Engines and Social Media
- **SEO Description:** Optional field to override the page description displayed for Search Engines and Social Media
- **Robots meta tag:** Optional field to add no-index or no-follow if the user prefers to hide pages from the search engines.
34 changes: 34 additions & 0 deletions docs/content-types-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

# Post content type

The post content types comes with the following fields:

- **Title:** The page title also used for the SEO page title
- **Description:** Used on the teaser display as well as the SEO meta description
- **Featured Image:** Used at the top of the page as a header as well as the card image on the teaser display
- **Overlay:** Changes the overlay over the image and the text color of the header and summary text
Options:
- Light - 90%
- Light - 75%
- Light - 50%
- Light - 25%
- Dark - 90%
- Dark - 75%
- Dark - 50%
- Dark - 25%
- **Header Position:** Places the title and description in the header section
Options:
- Top
- Middle
- Bottom
- **Hide Header Section:** Used to hide the page title and image and summary so that paragraphs can be used instead to place content
- **Author**
- **Author URL**
- **External Source**
- **Body**
- **Relationships:** Used to add related posts
- **SEO Page Title:** Optional field to override the page title displayed for Search Engines and Social Media
- **SEO Image:** Optional field to override the Image displayed for Search Engines and Social Media
- **SEO Description:** Optional field to override the page description displayed for Search Engines and Social Media
- **Robots meta tag:** Optional field to add no-index or no-follow if the user prefers to hide pages from the search engines.
9 changes: 9 additions & 0 deletions docs/content-types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

# Content types

Saplings currently has the following content types:

- [Page](content-types-page.md)
- [Post](content-types-post.md)
- [Event](content-types-event.md)
File renamed without changes.
File renamed without changes.
19 changes: 5 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
# Saplings Drupal Recipe Suite Documentation

This site aims to document how to use the Saplings suite of Drupal recipes.
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
# Saplings Drupal Recipe Suite Documentation

## Project layout
Saplings is a highly configured open source content management system built on
the modern Drupal framework.

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
This site aims to document how to use the Saplings suite of Drupal recipes.
2 changes: 1 addition & 1 deletion docs/5-media.md → docs/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Media

[<img src="assets/images/media.gif">](https://www.loom.com/share/999be51038f94b57a2e4da27e2a15c17)
[![Screenshot](assets/images/media.gif)](https://www.loom.com/share/999be51038f94b57a2e4da27e2a15c17)

[Sapling Media Types and Responsive Image Styles - Watch Video](https://www.loom.com/share/999be51038f94b57a2e4da27e2a15c17)

Expand Down
2 changes: 1 addition & 1 deletion docs/4-menus.md → docs/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Menus

[<img src="assets/images/menus.gif">](https://www.loom.com/share/d0ccb3745b284b6285af1f1817813ab3)
[![Screenshot](assets/images/menus.gif)](https://www.loom.com/share/d0ccb3745b284b6285af1f1817813ab3)

[Saplings Built-in Menus - Watch Video](https://www.loom.com/share/d0ccb3745b284b6285af1f1817813ab3)

Expand Down
5 changes: 5 additions & 0 deletions docs/recipes-introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

# Saplings Recipes Introduction

@TODO
19 changes: 12 additions & 7 deletions docs/summary.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
<!--- This file is used for the Archbee table of contents. -->
- [Project Readme](../README.md)

## Table of contents

- [Introduction](index.md)
- [Content types](2-content-types.md)
- [Components](3-components.md)
- [Menus](4-menus.md)
- [Media](5-media.md)
- [Taxonomies](6-taxonomies.md)
- [Developer Documentation](7-developer-documentation.md)
- [Designer Documentation](7-designer-documentation.md)
- [Content types](content-types.md)
- [Page](content-types-page.md)
- [Post](content-types-post.md)
- [Event](content-types-event.md)
- [Components](components.md)
- [Media](media.md)
- [Menus](menus.md)
- [Taxonomies](taxonomies.md)
- [Designer Documentation](designers.md)
- [Developer Documentation](developers.md)
- [Recipes Introduction](recipes-introduction.md)

## Add Ons

Expand Down
2 changes: 2 additions & 0 deletions docs/6-taxonomies.md → docs/taxonomies.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![saplings](https://github.com/kanopi/saplings/assets/5177009/a6377e32-deb2-49d8-873a-f3dd5a36fa7c)

# Taxonomies

@TODO
21 changes: 19 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,25 @@ edit_uri: edit/main/docs/

nav:
- Home: index.md
- About:
- Example: 1-example.md
- Site Architecture:
- Content types:
- Page: content-types-page.md
- Post: content-types-post.md
- Event: content-types-event.md
- Components: components.md
- Media: media.md
- Menus: menus.md
- Taxonomies: taxonomies.md
- Add ons:
- Language Switcher: add-on-language-switcher.md
- Mega Menu: add-on-mega-menu.md
- Search: add-on-search.md
- For Designers:
- Designer Documentation: designers.md
- For Developers:
- Developer Documentation: developers.md
- Recipe Architecture:
- Introduction: recipes-introduction.md

theme:
name: material

0 comments on commit bd632f2

Please sign in to comment.