(true);
@@ -62,7 +62,7 @@ function TreeNode({ doc }: { doc: DocsStructure }) {
);
}
-function ListTree({ docs }: { docs: DocsStructure[] }) {
+function ListTree({ docs }: { docs: Doc[] }) {
return (
{docs.map(d => (
@@ -76,8 +76,8 @@ export default function SideBar({
versionOne,
versionTwo,
}: {
- versionOne: DocsStructure[];
- versionTwo: DocsStructure[];
+ versionOne: DocsStructure;
+ versionTwo: DocsStructure;
}) {
return (
@@ -85,7 +85,7 @@ export default function SideBar({
Onspring{' '}
API
-
+
);
}
diff --git a/src/app/lib/markdoc.ts b/src/app/lib/markdoc.ts
new file mode 100644
index 0000000..309d00c
--- /dev/null
+++ b/src/app/lib/markdoc.ts
@@ -0,0 +1,93 @@
+import Markdoc from '@markdoc/markdoc';
+import fs from 'fs';
+import path from 'path';
+import React, { ReactNode } from 'react';
+import Code from '../components/Code';
+import { Doc, Section } from './../types/types';
+const DOCS_PATH = path.join(process.cwd(), 'src/docs');
+
+function getCopyPath(version: string, doc: Doc): string {
+ if (doc.copy === undefined) {
+ return '';
+ }
+
+ return path.join(
+ DOCS_PATH,
+ version,
+ doc.folder,
+ doc.copy
+ );
+}
+
+function getExamplePath(version: string, doc: Doc): string {
+ if (doc.example === undefined) {
+ return '';
+ }
+
+ return path.join(
+ DOCS_PATH,
+ version,
+ doc.folder,
+ doc.example
+ );
+}
+
+const markDocConfig = {
+ tags: {
+ code: {
+ render: 'Code',
+ children: ['text'],
+ attributes: {
+ language: {
+ type: 'string',
+ },
+ },
+ },
+ },
+};
+
+function parseMarkdown(sourcePath: string): ReactNode {
+ const source = fs.readFileSync(sourcePath, 'utf8');
+ const ast = Markdoc.parse(source);
+ const content = Markdoc.transform(
+ ast,
+ markDocConfig as any
+ );
+ const children = Markdoc.renderers.react(content, React, {
+ components: {
+ Code: Code,
+ },
+ });
+
+ return children;
+}
+
+function getCopyChild(version: string, doc: Doc) {
+ const copyPath = getCopyPath(version, doc);
+ return parseMarkdown(copyPath);
+}
+
+function getExampleChild(version: string, doc: Doc) {
+ const examplePath = getExamplePath(version, doc);
+ return parseMarkdown(examplePath);
+}
+
+export function loadSections(
+ version: string,
+ docs: Doc[],
+ sections: Section[] = []
+): Section[] {
+ for (const doc of docs) {
+ sections.push({
+ title: doc.title,
+ copy: getCopyChild(version, doc),
+ example: getExampleChild(version, doc),
+ });
+
+ if (doc.children && doc.children.length > 0) {
+ loadSections(version, doc.children, sections);
+ }
+ }
+
+ return sections;
+}
diff --git a/src/app/page.tsx b/src/app/page.tsx
index fc6bebc..2de2abb 100644
--- a/src/app/page.tsx
+++ b/src/app/page.tsx
@@ -1,82 +1,21 @@
import { versionTwo } from '@/docs/version_002/docsStructure';
-import Markdoc from '@markdoc/markdoc';
-import fs from 'fs';
-import path from 'path';
import Section from './components/Section';
+import { loadSections } from './lib/markdoc';
import styles from './page.module.css';
-import { DocsStructure } from './types/types';
-
-type Section = {
- title: string;
- copy: string;
- example: string;
-};
-
-function loadSections(
- docs: DocsStructure[],
- sections: Section[] = []
-): Section[] {
- for (const doc of docs) {
- try {
- const copyPath = path.join(
- process.cwd(),
- 'src/docs',
- 'version_002',
- doc.folder,
- doc.copy!
- );
-
- const examplePath = path.join(
- process.cwd(),
- 'src/docs',
- 'version_002',
- doc.folder,
- doc.example!
- );
-
- const copySource = fs.readFileSync(copyPath, 'utf8');
- const exampleSource = fs.readFileSync(
- examplePath,
- 'utf8'
- );
-
- const copyAst = Markdoc.parse(copySource);
- const exampleAst = Markdoc.parse(exampleSource);
- const copyContent = Markdoc.transform(copyAst);
- const exampleContent = Markdoc.transform(exampleAst);
- const copyHtml = Markdoc.renderers.html(copyContent);
- const exampleHtml =
- Markdoc.renderers.html(exampleContent);
-
- sections.push({
- title: doc.title,
- copy: copyHtml,
- example: exampleHtml,
- });
-
- if (doc.children && doc.children.length > 0) {
- loadSections(doc.children, sections);
- }
- } catch (error) {
- console.log(error);
- continue;
- }
- }
-
- return sections;
-}
export default function Home() {
- const versionTwoSections = loadSections(versionTwo);
- console.log(versionTwoSections);
+ const versionTwoSections = loadSections(
+ versionTwo.version,
+ versionTwo.docs
+ );
+
return (
- {versionTwoSections.map(article => (
-
+ {versionTwoSections.map(section => (
+
+ {section.copy}
+ {section.example}
+
))}
);
diff --git a/src/app/types/types.ts b/src/app/types/types.ts
index 8741262..0b18077 100644
--- a/src/app/types/types.ts
+++ b/src/app/types/types.ts
@@ -1,7 +1,19 @@
+import { ReactNode } from 'react';
export type DocsStructure = {
+ version: string;
+ docs: Doc[];
+};
+
+export type Doc = {
title: string;
folder: string;
copy?: string;
example?: string;
- children?: DocsStructure[];
+ children?: Doc[];
+};
+
+export type Section = {
+ title: string;
+ copy: ReactNode;
+ example: ReactNode;
};
diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts
index 278c3b6..706f36c 100644
--- a/src/docs/version_001/docsStructure.ts
+++ b/src/docs/version_001/docsStructure.ts
@@ -1,11 +1,14 @@
import { DocsStructure } from '@/app/types/types';
-export const versionOne: DocsStructure[] = [
- {
- title: 'Introduction',
- folder: 'introduction',
- copy: 'copy.md',
- example: 'example.md',
- children: [],
- },
-];
+export const versionOne: DocsStructure = {
+ version: 'version_001',
+ docs: [
+ {
+ title: 'Introduction',
+ folder: 'introduction',
+ copy: 'copy.md',
+ example: 'example.md',
+ children: [],
+ },
+ ],
+};
diff --git a/src/docs/version_002/docsStructure.ts b/src/docs/version_002/docsStructure.ts
index 1fd9e1b..c59273f 100644
--- a/src/docs/version_002/docsStructure.ts
+++ b/src/docs/version_002/docsStructure.ts
@@ -1,18 +1,21 @@
import { DocsStructure } from '@/app/types/types';
-export const versionTwo: DocsStructure[] = [
- {
- title: 'Introduction',
- folder: 'introduction',
- copy: 'copy.md',
- example: 'example.md',
- children: [],
- },
- {
- title: 'Authentication',
- folder: 'authentication',
- copy: 'copy.md',
- example: 'example.md',
- children: [],
- },
-];
+export const versionTwo: DocsStructure = {
+ version: 'version_002',
+ docs: [
+ {
+ title: 'Introduction',
+ folder: 'introduction',
+ copy: 'copy.md',
+ example: 'example.md',
+ children: [],
+ },
+ {
+ title: 'Authentication',
+ folder: 'authentication',
+ copy: 'copy.md',
+ example: 'example.md',
+ children: [],
+ },
+ ],
+};
diff --git a/src/docs/version_002/introduction/copy.md b/src/docs/version_002/introduction/copy.md
index 59682ec..ec6e9e5 100644
--- a/src/docs/version_002/introduction/copy.md
+++ b/src/docs/version_002/introduction/copy.md
@@ -1,3 +1,7 @@
# Introduction
-This is the copy for the introduction page.
+The Onspring API is organized around REST. It enables external programs to retrieve, save, and delete data within your Onspring instance. The Onspring API implements version 3 of the Open API Specification (OAS).
+
+The Onspring API does support bulk operation for some, but not all endpoints. Bulk operations are not supported for endpoints that create, update, or delete data. The one exception is the bulk delete endpoint, which is used to delete multiple records at once.
+
+The Onspring API is used to interact with any Onspring instance regardless of whether it is a development, test, or production instance.
diff --git a/src/docs/version_002/introduction/example.md b/src/docs/version_002/introduction/example.md
index 27b751a..1a21780 100644
--- a/src/docs/version_002/introduction/example.md
+++ b/src/docs/version_002/introduction/example.md
@@ -1,3 +1,7 @@
# Example
This is the example for the introduction page.
+
+{% code language="javascript" %}
+console.log('hello world');
+{% /code %}