Skip to content

Commit f2824ea

Browse files
crandmckcrandmck
committed
Extract custom CSS, add indexes for classes, intererfaces, etc., tweak CSS
1 parent 6d51f2a commit f2824ea

File tree

10 files changed

+122
-69
lines changed

10 files changed

+122
-69
lines changed

‎docs/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# @contentauth/c2pa-node
66

7-
## Classes
7+
## [Classes](classes/index.md)
88

99
- [Builder](classes/Builder.md)
1010
- [CallbackCredentialHolder](classes/CallbackCredentialHolder.md)
@@ -15,7 +15,7 @@
1515
- [Reader](classes/Reader.md)
1616
- [Trustmark](classes/Trustmark.md)
1717

18-
## Interfaces
18+
## [Interfaces](interfaces/index.md)
1919

2020
- [BuilderInterface](interfaces/BuilderInterface.md)
2121
- [CallbackCredentialHolderInterface](interfaces/CallbackCredentialHolderInterface.md)
@@ -35,7 +35,7 @@
3535
- [TrustmarkInterface](interfaces/TrustmarkInterface.md)
3636
- [VerifyConfig](interfaces/VerifyConfig.md)
3737

38-
## Type Aliases
38+
## [Type Aliases](type-aliases/index.md)
3939

4040
- [CallbackSignerConfig](type-aliases/CallbackSignerConfig.md)
4141
- [ClaimVersion](type-aliases/ClaimVersion.md)
@@ -54,7 +54,7 @@
5454
- [TrustmarkVariant](type-aliases/TrustmarkVariant.md)
5555
- [TrustmarkVersion](type-aliases/TrustmarkVersion.md)
5656

57-
## Functions
57+
## [Functions](functions/index.md)
5858

5959
- [getCawgTrustConfig](functions/getCawgTrustConfig.md)
6060
- [getSettingsJson](functions/getSettingsJson.md)

‎docs/_includes/custom-head.html‎

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1 @@
1-
{% comment %}
2-
Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons:
3-
4-
1. Head over to https://realfavicongenerator.net/ to add your own favicons.
5-
2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet.
6-
{% endcomment %}
7-
<style>
8-
.site-layout {
9-
display: grid;
10-
grid-template-columns: minmax(220px, 320px) 1fr;
11-
gap: 2rem;
12-
}
13-
.wrapper.site-layout { max-width: 1200px; }
14-
.sidebar {
15-
position: sticky;
16-
top: 1rem;
17-
max-height: calc(100vh - 2rem);
18-
overflow: auto;
19-
padding-right: 0.75rem;
20-
border-right: 1px solid #eaecef;
21-
max-width: 320px;
22-
}
23-
.sidebar-content { font-size: 0.95em; line-height: 1.45; }
24-
.sidebar-content h1 { font-size: 1.1rem; margin-top: 1rem; }
25-
.sidebar-content h2 { font-size: 1rem; margin-top: 0.9rem; }
26-
.sidebar-content h3 { font-size: 0.95rem; margin-top: 0.8rem; }
27-
.sidebar-content ul { list-style: none; padding-left: 0; }
28-
.sidebar-content li { margin: 0.25rem 0; }
29-
.site-main { min-width: 0; }
30-
/* Left-align site header with small padding */
31-
.site-header > .wrapper {
32-
max-width: none;
33-
margin: 0;
34-
padding-left: 12px;
35-
padding-right: 12px;
36-
}
37-
/* Hide top link to README and following hr generated by typedoc markdown in pages and sidebar */
38-
39-
.post-content > p:first-child { display: none; }
40-
.post-content hr { display: none; }
41-
42-
.sidebar-content > p:first-child { display: none; }
43-
.sidebar-content hr { display: none; }
44-
45-
@media (max-width: 900px) {
46-
.site-layout { grid-template-columns: 1fr; }
47-
.sidebar { display: none; }
48-
}
49-
</style>
1+
<link id="main-stylesheet" rel="stylesheet" href="{{ '/assets/css/cai-custom.css' | relative_url }}">

‎docs/_includes/header.html‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@
88

99
{%- unless page_titles == empty %}
1010
<nav class="site-nav">
11-
<input type="checkbox" id="nav-trigger" />
12-
<label for="nav-trigger">
13-
<span class="menu-icon"></span>
14-
</label>
1511

1612
{% include nav-items.html paths = page_paths %}
1713
</nav>

‎docs/_layouts/base.html‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
{%- include header.html -%}
99

1010
<main class="page-content" aria-label="Content">
11-
{%- if page.layout != 'home' -%}
11+
1212
<div class="wrapper site-layout">
1313
<aside class="sidebar">
1414
{%- include sidebar.html -%}
@@ -17,11 +17,7 @@
1717
{{ content }}
1818
</div>
1919
</div>
20-
{%- else -%}
21-
<div class="wrapper">
22-
{{ content }}
23-
</div>
24-
{%- endif -%}
20+
2521
</main>
2622

2723
{%- include footer.html -%}

‎docs/_layouts/page.html‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@
33
---
44
<article class="post">
55

6-
{%- if page.title -%}
7-
<header class="post-header">
8-
<h1 class="post-title">{{ page.title | escape }}</h1>
9-
</header>
10-
{%- endif -%}
11-
126
<div class="post-content">
137
{{ content }}
148
</div>

‎docs/assets/css/cai-custom.css‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.site-layout {
2+
display: grid;
3+
grid-template-columns: minmax(220px, 320px) 1fr;
4+
gap: 2rem;
5+
}
6+
.wrapper.site-layout { max-width: 1200px; }
7+
.sidebar {
8+
position: sticky;
9+
top: 1rem;
10+
max-height: calc(100vh - 2rem);
11+
overflow: auto;
12+
padding-right: 0.75rem;
13+
border-right: 1px solid #eaecef;
14+
max-width: 320px;
15+
}
16+
.sidebar-content { font-size: 0.95em; line-height: 1.45; }
17+
.sidebar-content h1 { font-size: 1.1rem; margin-top: 1rem; }
18+
.sidebar-content h2 { font-size: 1rem; margin-top: 0.9rem; }
19+
.sidebar-content h3 { font-size: 0.95rem; margin-top: 0.8rem; }
20+
.sidebar-content ul { list-style: none; padding-left: 0; }
21+
.sidebar-content li { margin: 0.25rem 0; }
22+
.site-main { min-width: 0; }
23+
24+
/* Left-align site header with small padding */
25+
.site-header > .wrapper {
26+
max-width: none;
27+
margin: 0;
28+
padding-left: 12px;
29+
padding-right: 12px;
30+
}
31+
32+
.nav-item {
33+
margin-left: 0.25rem;
34+
margin-right: 0.25rem;
35+
}
36+
37+
/* Hide top link to README and following hr generated by typedoc markdown in pages and sidebar */
38+
.post-content > p:first-child { display: none; }
39+
.post-content hr { display: none; }
40+
.post-content h1 { margin-bottom: 1.5rem; }
41+
42+
/* Hide text and hr in home page too */
43+
.home > p:first-child { display: none; }
44+
.home hr { display: none; }
45+
46+
47+
.sidebar-content > p:first-child { display: none; }
48+
.sidebar-content hr { display: none; }
49+
50+
@media (max-width: 900px) {
51+
.site-layout { grid-template-columns: 1fr; }
52+
.sidebar { display: none; }
53+
}

‎docs/classes/index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Classes
2+
3+
- [Builder](Builder.md)
4+
- [CallbackCredentialHolder](CallbackCredentialHolder.md)
5+
- [CallbackSigner](CallbackSigner.md)
6+
- [IdentityAssertionBuilder](IdentityAssertionBuilder.md)
7+
- [IdentityAssertionSigner](IdentityAssertionSigner.md)
8+
- [LocalSigner](LocalSigner.md)
9+
- [Reader](Reader.md)
10+
- [Trustmark](Trustmark.md)

‎docs/functions/index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Functions
2+
3+
- [getCawgTrustConfig](getCawgTrustConfig.md)
4+
- [getSettingsJson](getSettingsJson.md)
5+
- [getTrustConfig](getTrustConfig.md)
6+
- [getVerifyConfig](getVerifyConfig.md)
7+
- [isActionsAssertion](isActionsAssertion.md)
8+
- [loadC2paSettings](loadC2paSettings.md)
9+
- [loadC2paSettingsToml](loadC2paSettingsToml.md)
10+
- [loadCawgTrustConfig](loadCawgTrustConfig.md)
11+
- [loadSettingsFromFile](loadSettingsFromFile.md)
12+
- [loadSettingsFromUrl](loadSettingsFromUrl.md)
13+
- [loadTrustConfig](loadTrustConfig.md)
14+
- [loadVerifyConfig](loadVerifyConfig.md)
15+
- [patchVerifyConfig](patchVerifyConfig.md)

‎docs/interfaces/index.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Interfaces
2+
3+
- [BuilderInterface](BuilderInterface.md)
4+
- [CallbackCredentialHolderInterface](CallbackCredentialHolderInterface.md)
5+
- [CallbackSignerInterface](CallbackSignerInterface.md)
6+
- [DestinationBufferAsset](DestinationBufferAsset.md)
7+
- [FileAsset](FileAsset.md)
8+
- [HashedUri](HashedUri.md)
9+
- [IdentityAssertionBuilderInterface](IdentityAssertionBuilderInterface.md)
10+
- [IdentityAssertionSignerInterface](IdentityAssertionSignerInterface.md)
11+
- [JsCallbackSignerConfig](JsCallbackSignerConfig.md)
12+
- [LocalSignerInterface](LocalSignerInterface.md)
13+
- [ReaderInterface](ReaderInterface.md)
14+
- [SignerPayload](SignerPayload.md)
15+
- [SourceBufferAsset](SourceBufferAsset.md)
16+
- [TrustConfig](TrustConfig.md)
17+
- [TrustmarkConfig](TrustmarkConfig.md)
18+
- [TrustmarkInterface](TrustmarkInterface.md)
19+
- [VerifyConfig](VerifyConfig.md)

‎docs/type-aliases/index.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Type Aliases
2+
3+
- [CallbackSignerConfig](CallbackSignerConfig.md)
4+
- [ClaimVersion](ClaimVersion.md)
5+
- [DestinationAsset](DestinationAsset.md)
6+
- [ManifestAssertionKind](ManifestAssertionKind.md)
7+
- [NeonBuilderHandle](NeonBuilderHandle.md)
8+
- [NeonCallbackCredentialHolderHandle](NeonCallbackCredentialHolderHandle.md)
9+
- [NeonCallbackSignerHandle](NeonCallbackSignerHandle.md)
10+
- [NeonIdentityAssertionBuilderHandle](NeonIdentityAssertionBuilderHandle.md)
11+
- [NeonIdentityAssertionSignerHandle](NeonIdentityAssertionSignerHandle.md)
12+
- [NeonLocalSignerHandle](NeonLocalSignerHandle.md)
13+
- [NeonReaderHandle](NeonReaderHandle.md)
14+
- [NeonTrustmarkHandle](NeonTrustmarkHandle.md)
15+
- [SigningAlg](SigningAlg.md)
16+
- [SourceAsset](SourceAsset.md)
17+
- [TrustmarkVariant](TrustmarkVariant.md)
18+
- [TrustmarkVersion](TrustmarkVersion.md)

0 commit comments

Comments
 (0)