Skip to content

Commit

Permalink
Merge branch 'main' into documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thejimbirch authored Dec 26, 2024
2 parents 13eecfa + 68698cb commit 4458f47
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .archbee.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
structure:
summary: summary.md
readme: 1-introduction.md
readme: index.md
publishSpace: true
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"kanopi/saplings-base": "^1",
"kanopi/saplings-content-types": "^1",
"kanopi/saplings-editorial": "^1.0.0-beta.9",
"kanopi/saplings-launch": "^1",
"kanopi/saplings-launch": "^1.0.0.beta.6",
"kanopi/saplings-tests": "^1"
},
"suggest": {
Expand Down
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Saplings Drupal Recipe Suite Documentation

This site aims to document how to use the Saplings suite of Drupal recipes.

## 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.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
18 changes: 9 additions & 9 deletions docs/summary.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
- [README](../README.md)
- [Project Readme](../README.md)

## Table of contents

- [1. Introduction](1-introduction.md)
- [2. Content types](2-content-types.md)
- [3. Components](3-components.md)
- [4. Menus](4-menus.md)
- [5. Media](5-media.md)
- [6. Taxonomies](6-taxonomies.md)
- [7. Developer Documentation](7-developer-documentation.md)
- [8. Designer Documentation](7-designer-documentation.md)
- [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)

## Add Ons

Expand Down
13 changes: 13 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
site_name: Saplings Documentation
site_description: This recipe is designed to help start a highly configured Drupal project.
site_url: https://kanopi.github.io/saplings
repo_url: https://github.com/kanopi/saplings
edit_uri: edit/main/docs/

nav:
- Home: index.md
- About:
- Example: 1-example.md

theme:
name: material

0 comments on commit 4458f47

Please sign in to comment.