Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add starter development info to docs #677

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add starter development info to docs #677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions content/docs-v1/for-developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,46 @@ https://github.com/thegetty/quire-docs

This repository is specifically for the Quire website and documentation.

### quire-starter-default

https://github.com/thegetty/quire-starter-default

The default starter for a Quire project

### quire-starter-iiif

https://github.com/thegetty/quire-starter-iiif

A starter with more examples of IIIF features

## Local Development

### `quire-11ty`

To create a new project with a local `quire-11ty` package, use `quire new` with the `--quire-path` option and path to your local `quire-11ty` package.

```
quire new my-project --quire-path ~/path/to/local/quire/packages/11ty/
```

### Starters

To create a new project with a local or remote starter, you can pass an absoulte path or url as the second parameter to `quire new`.

```
quire new my-project ~/path/to/local/starter/
```

```
quire new my-project https://github.com/thegetty/quire-starter-iiif.git
```

#### `quire-11ty` compatibility

At its most basic, a Quire starter contains a `package.json`, styles, global data files, and markdown templates for a Quire project. A starter is a standalone repository separate from the main [`quire`](http://github.com/thegetty/quire) repository. When creating a new project with the `quire new` command, the starter contents are merged with the contents of the `quire-11ty` package to create a Quire project. Since these packages are somewhat interdependent, modifications to the markup in the `quire-11ty` project, or to the styles and YAML structures in the starter may also require changes to the other project.

To address this, a starter's `package.json` lists `quire-11ty` as a peer dependency. The `quire-11ty` version should be specified as "latest" or using [semantic versioning](https://semver.org) to pin the starter to an older version if compatibility with later releases is an issue.

## Configuration

TK
Expand Down