Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
1b580ef
feat: updated Landing and Doc pages
prosdev0107 Apr 22, 2022
f122f4d
feat(assets): Updated images and svgs
prosdev0107 Apr 25, 2022
3cbb392
feat(doc-page): Updated basic style in doc page
prosdev0107 Apr 27, 2022
8d29f94
Added hero-section animation
prosdev0107 May 3, 2022
b28987f
Adds static hero image.
theenoahmason May 10, 2022
c4aed31
Runs prettier.
theenoahmason May 10, 2022
92590f6
Removes old hero bg.
theenoahmason May 10, 2022
0ab124e
Updates tagine.
theenoahmason May 10, 2022
fba88d5
Adds to prettier ignore.
theenoahmason May 10, 2022
aced6d0
Fixes pretter command on lint staged.
theenoahmason May 10, 2022
e710731
Lint only staged files with prettier.
theenoahmason May 10, 2022
497b696
Adds suggested extensions.
theenoahmason May 10, 2022
61b6a30
Adds vscode dev settings.
theenoahmason May 10, 2022
35abfd9
Adds custom css.
theenoahmason May 10, 2022
0e180d6
Begins restructuring homepage.
theenoahmason May 10, 2022
8cae88d
Tests prettier.
theenoahmason May 10, 2022
141782f
Adds command to format all files with prettier.
theenoahmason May 10, 2022
4801e97
Runs prettier on all files.
theenoahmason May 10, 2022
e3a4079
Moves icons to assets folder inside src.
theenoahmason May 10, 2022
7a6b9f4
Renames HomepageTable to ComparisonTable for reusability.
theenoahmason May 10, 2022
5d64e3d
Renames HomepageFeatures to Features for reusability.
theenoahmason May 10, 2022
90480ac
Removes old HomepageTable component.
theenoahmason May 10, 2022
08cd794
Separates data from components.
theenoahmason May 10, 2022
58f1274
Begins takeover of project.
theenoahmason May 11, 2022
c6df0f5
Adds overflow styles to feature CTAs
theenoahmason May 11, 2022
e8954f9
Adds overflow styles to feature CTAs 2
theenoahmason May 11, 2022
35d9cfc
Fixes text size on feature descriptions on mobile.
theenoahmason May 11, 2022
1016140
Swaps hero SVG and moves ui scripts to clientModules.
theenoahmason May 16, 2022
a01e9e4
Adds more md examples.
theenoahmason May 16, 2022
a0355eb
Adds new hero image.
theenoahmason May 16, 2022
ec6383d
Adds global ui script file.
theenoahmason May 16, 2022
70e4724
Adds styles.
theenoahmason May 16, 2022
3c887f4
Adds mobile menu styles.
theenoahmason May 16, 2022
68bbc8d
Ensures body scroll script fires immediately.
theenoahmason May 16, 2022
0139db8
Increases gap on feature columns.
theenoahmason May 16, 2022
f935f89
Adds transition to verify button.
theenoahmason May 16, 2022
245f34e
Replaces homepage images.
theenoahmason May 16, 2022
6e52358
Fixes top margin on sticky sidebar.
theenoahmason May 16, 2022
cfa8fcf
Adds dynamic var for container width on docs page.
theenoahmason May 16, 2022
6d82aa2
Adds link to hero blurb.
theenoahmason May 16, 2022
e2c5197
Adds space to admonition icon.
theenoahmason May 16, 2022
eafaa00
Fixes build error.
theenoahmason May 16, 2022
a125c00
Comments client module issue.
theenoahmason May 16, 2022
f71cdc1
Removes module classes from custom.css.
theenoahmason May 16, 2022
fd1d860
Adds toc back and styles stickiness.
theenoahmason May 16, 2022
f42a823
Fixes container and stickiness on docs pages.
theenoahmason May 16, 2022
4d2b05c
Resizes images.
theenoahmason May 16, 2022
eafc22a
Optimizes images.
theenoahmason May 16, 2022
02cdcee
Adds new homepage images.
theenoahmason May 18, 2022
b8acaee
Reconfigures nav bar config.
theenoahmason May 18, 2022
62fb07d
Reconfigures defualt docs.
theenoahmason May 18, 2022
d210891
fixes links.
theenoahmason May 18, 2022
b3a3e1b
Adds proper footer links.
theenoahmason May 18, 2022
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
5 changes: 4 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Ignore artifacts:
build
/build

# Package files
package-lock.json
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["esbenp.prettier-vscode"]
}
10 changes: 10 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"editor.tabSize": 2,
"files.eol": "\n",
"files.associations": {
"*.svg": "html"
}
}
5 changes: 5 additions & 0 deletions docs/get-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Get Started
5 changes: 5 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Introduction
2 changes: 1 addition & 1 deletion docs/tutorial-basics/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Tutorial - Basics",
"position": 2
"position": 3
}
2 changes: 1 addition & 1 deletion docs/tutorial-basics/congratulations.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
---

# Congratulations!
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-basics/create-a-blog-post.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---

# Create a Blog Post
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-basics/create-a-document.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
---

# Create a Document
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-basics/create-a-page.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 2
---

# Create a Page
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-basics/deploy-your-site.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---

# Deploy your site
Expand Down
File renamed without changes.
59 changes: 50 additions & 9 deletions docs/tutorial-basics/markdown-features.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Markdown Features
Expand Down Expand Up @@ -39,6 +39,28 @@ Let's see how to [Create a page](./create-a-page.md).

**Result:** Let's see how to [Create a page](./create-a-page.md).

## Lists

Markdown lists can be rendered as ordered or unordered, and can be nested.

```md
- Unordered list item 1.
- Unordered list item 2.
- Unordered list item 3.

1. Ordered list item 1.
1. Ordered list item 2.
1. Ordered list item 3.
```

- Unordered list item 1.
- Unordered list item 2.
- Unordered list item 3.

1. Ordered list item 1.
2. Ordered list item 2.
3. Ordered list item 3.

## Images

Regular Markdown images are supported.
Expand Down Expand Up @@ -85,15 +107,33 @@ Docusaurus has a special syntax to create admonitions and callouts:

:::

:::tip My tip
:::note

Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::

:::info

Use this awesome feature option
Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::

:::danger Take care
:::tip

This action is dangerous
Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::

:::caution

Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::

:::danger

Some **content** with _markdown_ `syntax`. Check [this `api`](#).

:::

Expand All @@ -108,7 +148,7 @@ export const Highlight = ({children, color}) => (
backgroundColor: color,
borderRadius: '20px',
color: '#fff',
padding: '10px',
padding: '10px 20px',
cursor: 'pointer',
}}
onClick={() => {
Expand All @@ -123,18 +163,19 @@ This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
```

export const Highlight = ({children, color}) => (
export const Highlight = ({ children, color }) => (
<span
style={{
backgroundColor: color,
borderRadius: '20px',
color: '#fff',
padding: '10px',
padding: '10px 20px',
cursor: 'pointer',
}}
onClick={() => {
alert(`You clicked the color ${color} with label ${children}`);
}}>
}}
>
{children}
</span>
);
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-extras/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Tutorial - Extras",
"position": 3
"position": 4
}
72 changes: 18 additions & 54 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'CAI Open Source',
tagline: 'Open source tools for tracing media provenance',
tagline: 'Open-source tools for content authenticity and provenance',
url: 'https://contentauth.netlify.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.png',
favicon: '/favicon.png',
organizationName: 'contentauth',
projectName: 'opensource.contentauth.org',
clientModules: [require.resolve('./static/scripts/ui.js')],
stylesheets: [
// Acumin Pro (temporary)
'https://use.typekit.net/wgs7uns.css',
// Adobe Clean
'https://use.typekit.net/dnb4eqs.css',
],

presets: [
[
'classic',
Expand All @@ -36,90 +36,54 @@ const config = {
}),
],
],

// See here for configuration options:
// https://docusaurus.io/docs/api/themes/configuration
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// announcementBar: {
// id: 'sample',
// content:
// '<strong>Note:</strong> Our SDK is still pre-1.0. Features and API may change.',
// backgroundColor: '#ffca32',
// textColor: '#2b2b2b',
// isCloseable: true,
// },
colorMode: {
disableSwitch: true,
},
navbar: {
logo: {
alt: 'Content Authenticity Initiative',
src: 'img/logo-text.svg',
src: 'img/logo-cai.svg',
width: 180,
height: 54,
},
items: [
{
type: 'doc',
docId: 'intro',
to: '/docs/get-started',
position: 'right',
label: 'Get started',
},
{
href: 'https://github.com/contentauth',
label: 'GitHub',
to: '/docs/introduction',
position: 'right',
label: 'Docs',
activeBaseRegex: '/docs/(?!get-started)',
},
{
href: 'https://www.contentauthenticity.org',
to: 'https://www.contentauthenticity.org',
label: 'Learn more',
position: 'right',
},
{
href: 'https://verify.contentauthenticity.org',
to: 'https://verify.contentauthenticity.org',
label: 'Verify',
position: 'right',
className: 'navbar__button',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/contentauth',
},
{
label: 'Twitter',
href: 'https://twitter.com/contentauth',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/contentauth',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Adobe`,
style: 'light',
logo: {
src: '#', // stop warning.
alt: 'Content Authenticity Initiative',
href: 'https://contentauthenticity.org',
},
copyright: `Copyright © ${new Date().getFullYear()} Adobe. All rights reserved. <a href="https://www.adobe.com/privacy.html" target="_blank" rel="noopener noreferrer">Privacy</a> | <a href="https://www.adobe.com/legal/terms.html" target="_blank" rel="noopener noreferrer">Terms of Use</a> | <a href="/">Cookie Preferences</a>`,
},
prism: {
theme: lightCodeTheme,
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"prepare": "husky install"
"prepare": "husky install",
"prettier": "prettier --ignore-unknown --write ."
},
"dependencies": {
"@docusaurus/core": "2.0.0-beta.18",
Expand Down Expand Up @@ -41,6 +42,6 @@
"prettier": "2.6.2"
},
"lint-staged": {
"**/*": "prettier --write --ignore-unknown"
"**/*": "prettier --ignore-unknown --write"
}
}
3 changes: 2 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
apiSidebar: [],

// But you can create a sidebar manually
/*
Expand Down
6 changes: 6 additions & 0 deletions src/assets/images/check.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions src/assets/images/cli.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading