Merge pull request #47 from kilbergr/rek-docs-page

docs page
harvard-lil · Feb 1, 2024 · d182757 · d182757
2 parents e34440a + 1d15a07
commit d182757
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 0 deletions.
diff --git a/src/data/docsSidebarLinks.js b/src/data/docsSidebarLinks.js
@@ -0,0 +1,10 @@
+export const anchorLinks = [
+	{
+		title: "Accessing Data",
+		url: "#accessing-data",
+	},
+	{
+		title: "Bulk Downloads",
+		url: "#bulk-downloads",
+	},
+];
diff --git a/src/docs/index.html b/src/docs/index.html
@@ -0,0 +1,22 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<title>Documentation | Caselaw Access Project</title>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<meta name="robots" content="noindex" />
+		<meta name="author" content="Your name" />
+		<meta name="description" content="Explore American Caselaw" />
+		<meta property="og:title" content="Caselaw Access Project" />
+		<meta property="og:description" content="Explore American Caselaw" />
+		<meta property="og:url" content="https://case.law/" />
+		<meta property="og:type" content="article" />
+		<meta property="og:site_name" content="Caselaw Access Projects" />
+
+		<link href="/css/global.css" rel="stylesheet" />
+		<script type="module" src="/templates/cap-docs-page.js"></script>
+	</head>
+	<body>
+		<cap-docs-page></cap-docs-page>
+	</body>
+</html>
diff --git a/src/templates/cap-docs-page.js b/src/templates/cap-docs-page.js
@@ -0,0 +1,46 @@
+import { LitElement, html } from "../lib/lit.js";
+import "../components/cap-nav.js";
+import "../components/cap-page-header.js";
+import "../components/cap-footer.js";
+import "../components/cap-anchor-list.js";
+import { anchorLinks } from "../data/docsSidebarLinks.js";
+
+export class CapDocsPage extends LitElement {
+	// Turn Shadow DOM off
+	// Generally discouraged: https://lit.dev/docs/components/shadow-dom/#implementing-createrenderroot
+	createRenderRoot() {
+		return this;
+	}
+
+	render() {
+		return html`
+			<cap-nav></cap-nav>
+			<main id="main" class="l-interiorPage">
+				<header class="u-bg-gray-500 u-col-span-full">
+					<cap-page-header heading="Documentation">
+						<p class="u-text-white u-text-serif">
+							Welcome to the Caselaw Access Project Documentation. Here you'll
+							find some documentation about our project, organization, data, and
+							site.
+						</p>
+					</cap-page-header>
+				</header>
+				<aside class="u-sm-hidden">
+					<cap-anchor-list .data=${anchorLinks}></cap-anchor-list>
+				</aside>
+				<article class="c-article u-bg-beige">
+					<h2 class="c-decoratedHeader" id="accessing-data">Accessing Data</h2>
+					<p>
+						[We will put some documentation content about accessing data here.]
+					</p>
+					<h2 class="c-decoratedHeader" id="bulk-downloads">Bulk Downloads</h2>
+					<p>
+						[We will put some documentation content about bulk downloads here.]
+					</p>
+				</article>
+			</main>
+			<cap-footer></cap-footer>
+		`;
+	}
+}
+customElements.define("cap-docs-page", CapDocsPage);