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.

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

Update cookbooks coverage #191

Merged
merged 14 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,17 @@ src/main/tools/eclipse

# In support of using $revision in the version element in the POM
.flattened-pom.xml

# In support of creating an uber jar
dependency-reduced-pom.xml

# Build tools only needed for site generation
docs/node_modules

# The build location the documentation site
public/

# Ignores for the documentation site generated with Hugo
docs/resources/_gen
docs/public/
docs/.env
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/themes/compose"]
path = docs/themes/compose
url = https://github.com/onweru/compose/
Empty file added docs/.hugo_build.lock
Empty file.
5 changes: 5 additions & 0 deletions docs/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
date = {{ .Date }}
draft = true
+++
31 changes: 31 additions & 0 deletions docs/assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

// Making fonts a little more readable for older eyes (like mine)
.lead .mt-5 { font-weight: 500; text-shadow: black 1px 1px; }
.display-1 { font-weight: 500; text-shadow: black 1px 1px; }
.td-navbar .navbar-brand__name { font-weight: 700; margin-left: 10px; text-shadow: black 1px 1px; }

// Tweak the color scheme and layout on Home and About pages
.td-box--3 { background-color: white; }
.td-footer { padding-top: 1em; min-height: 75px; }

// Give a little more whitespace around items in the in-page TOCs
.td-page-meta a { padding-top: 30px; }

// Hide links to the doc sources, leaving just a feedback button
.td-page-meta__child { display: none !important; }
.td-page-meta__view { display: none !important; }
.td-page-meta__edit { display: none !important; }

// Table tweaks
.td-sidebar-nav__section .ul-1 ul { padding-left: .75em; }
.td-sidebar-nav > .td-sidebar-nav__section { padding-left: .75em; }
.status { width: 28px; }
.table { --bs-table-striped-bg: #fff; }
td:nth-child(3) { text-align: center !important; }
td:nth-child(2) { text-align: left !important; padding-left: 1.5em !important; }

.td-max-width-on-larger-screens {
@include media-breakpoint-up(lg) {
max-width: 95%;
}
}
14 changes: 14 additions & 0 deletions docs/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

div {
--bs-info-rgb: white;
}

.nav-link {
--bs-nav-link-color: white;
}

$primary: #4c543c !default;
$secondary: #b6a284 !default;
$dark: #443C54 !default;
$info: #e4e3cd !default;
$link-color: #4c543c !default;
62 changes: 62 additions & 0 deletions docs/content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: JPv3
---

{{< blocks/cover title="Welcome to JPv3" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="docs/">
Read the Docs <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/ksclarke/jiiify-presentation/tree/v3">
View the Code <i class="fab fa-github ms-2 "></i>
</a>
<p class="lead mt-5">A Java library for working with IIIF Presentation manifests</p>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}} Jiiify Presentation (JPv3) does not contain a server from which to serve manifests, but could be used as a component of a manifest
server or batch processing workflow that <i>you</i> write.{{% /blocks/lead %}}


{{% blocks/section color="dark" type="row" %}}

{{% blocks/feature icon="fa-list-check" title="Cookbook Compliance" %}}
JPv3 uses the <a href="https://iiif.io/api/cookbook/">IIIF Cookbook</a> recipes to ensure compliance with the Presentation specification.

See which recipes have and have and have not (yet) been implemented on <a href="">our recipes page</a>.
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions Welcome!" %}} You can contribute by
asking a question on the discussion board or reporting a bug.

If you'd like to contribute to the code base, you can
{{% /blocks/feature %}}


{{% blocks/feature icon="fa-rss" title="Follow Our Blog's RSS Feed" url="https://twitter.com/docsydocs" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}


{{% /blocks/section %}}


{{% blocks/section type="row" %}}

{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-github" title="Contributions welcome!"
url="https://github.com/google/docsy-example" %}}
We do a [Pull Request](https://github.com/google/docsy-example/pulls)
contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!"
url="https://twitter.com/GoHugoIO" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}

{{% /blocks/section %}}
Binary file added docs/content/en/about/featured-background.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/content/en/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: About JPv3
linkTitle: About
menu: {main: {weight: 10}}
---

{{% blocks/cover title="Jiiify Presentation (v3)" image_anchor="top" height="full" %}} <p class="lead mt-5">JPv3 provides a Java API for people who aren't Linked Data
experts,<br/>while trying to support the various extensions to the v3 specification.</p> {{% /blocks/cover %}}



{{% blocks/section type="row" %}}

{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
{{% /blocks/feature %}}

{{% /blocks/section %}}
8 changes: 8 additions & 0 deletions docs/content/en/blog/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Blog
menu: {main: {weight: 30}}
---

This is the **blog** section. It has two categories: News and Releases.

Files in these directories will be listed in reverse chronological order.
4 changes: 4 additions & 0 deletions docs/content/en/blog/news/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: News
weight: 20
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions docs/content/en/blog/news/first-post/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
date: 2018-10-06
title: Easy documentation with Docsy
linkTitle: Announcing Docsy
description: >
The Docsy Hugo theme lets project maintainers and contributors focus on content,
not on reinventing a website infrastructure from scratch
author: Riona MacNamara ([@rionam](https://twitter.com/bepsays))
resources:
- src: "**.{png,jpg}"
title: "Image #:counter"
params:
byline: "Photo: Riona MacNamara / CC-BY-CA"
---

**This is a typical blog post that includes images.**

The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author.

## Including images

Here's an image (`featured-sunset-get.png`) that includes a byline and a caption.

{{< imgproc sunset Fill "600x300" >}}
Fetch and scale an image in the upcoming Hugo 0.43.
{{< /imgproc >}}

The front matter of this post specifies properties to be assigned to all image resources:

```
resources:
- src: "**.{png,jpg}"
title: "Image #:counter"
params:
byline: "Photo: Riona MacNamara / CC-BY-CA"
```

To include the image in a page, specify its details like this:

```
{{< imgproc sunset Fill "600x300" >}}
Fetch and scale an image in the upcoming Hugo 0.43.
{{< /imgproc >}}
```

The image will be rendered at the size and byline specified in the front matter.


Loading
Loading