samvera / serverless-iiif

IIIF Image API 2.1 & 3.0 server in an AWS Serverless Application
https://samvera.github.io/serverless-iiif/
Apache License 2.0
69 stars 21 forks source link

Update documentation and create static site #118

Closed adamjarling closed 1 year ago

adamjarling commented 1 year ago

What does this do?

Adds a documentation, homepage, and static site solution to this Github repo.

image

image

Here's the contents of the /docs/README.md for more info.

This documentation uses Nextra. The documentation app is a NextJS app which lives in the /docs directory and is isolated from the rest of the root serverless-iiif project files.

Updating documentation

Navigate to the /docs directory, and run

# Install dependencies
npm install

# Start the app
npm dev

Generate static site docs

Run npm run build, which will output the static site in /docs/out.

adamjarling commented 1 year ago

@mbklein If you want to move forward with this, we should probably squash all the commits before merging.

mbklein commented 1 year ago

This looks great, @adamjarling! Thanks!