Skip to content
Open
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
5 changes: 5 additions & 0 deletions website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};


67 changes: 67 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Docusaurus v2 configuration migrated from v1 siteConfig.js
// Minimal viable config; follow-ups: Algolia, custom highlight, users page

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Accord Project',
tagline: 'Documentation',
url: 'https://docs.accordproject.org',
baseUrl: '/',
favicon: 'img/favicon.png',
organizationName: 'accordproject',
projectName: 'techdocs',

i18n: { defaultLocale: 'en', locales: ['en'] },

presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */ (
{
docs: {
path: '../docs',
routeBasePath: '/',
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/accordproject/techdocs/edit/main/website/',
showLastUpdateTime: true,
},
blog: false,
theme: {
customCss: require.resolve('./static/css/main.css'),
},
}
),
],
],

themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({
colorMode: { respectPrefersColorScheme: true },
navbar: {
title: 'Accord Project',
logo: { alt: 'Accord Project', src: 'img/A-MARK-ACCORDPROJECT-ONELINE-white.svg' },
items: [
{ to: '/', label: 'Documentation', position: 'left' },
{ href: 'https://studio.accordproject.org', label: 'Try Online!', position: 'left' },
{ href: 'https://github.com/accordproject', label: 'GitHub', position: 'right' },
{ type: 'search', position: 'right' },
],
},
footer: {
style: 'dark',
copyright: `Copyright © 2018-${new Date().getFullYear()} Accord Project, LLC.`,
},
prism: {
theme: require('prism-react-renderer/themes/dracula'),
},
algolia: {
// Placeholder; requires v2 index/app settings
appId: 'auto',
apiKey: '1679802ddfc315329d6b5f4616b30e51',
indexName: 'accordproject_api',
},
}),
};

module.exports = config;


27 changes: 14 additions & 13 deletions website/package.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
{
"scripts": {
"examples": "docusaurus-examples",
"start": "docusaurus-start",
"build": "docusaurus-build",
"build:api": "./scripts/build_api_md.sh",
"publish-gh-pages": "docusaurus-publish",
"write-translations": "docusaurus-write-translations",
"version": "docusaurus-version",
"rename-version": "docusaurus-rename-version"
},
"name": "accordproject-techdocs",
"private": true,
"description": "Technical Documentation for the Accord Project",
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "https://github.com/accordproject/techdocs.git"
},
"scripts": {
"start": "docusaurus start",
"build": "docusaurus build",
"serve": "docusaurus serve",
"swizzle": "docusaurus swizzle",
"build:api": "./scripts/build_api_md.sh"
},
"dependencies": {
"@docusaurus/core": "^2.4.3",
"@docusaurus/preset-classic": "^2.4.3",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"axios": "^0.21.2",
"docusaurus": "^1.14.7",
"qs": "^6.9.6",
"remarkable-admonitions": "^0.2.2"
"qs": "^6.9.6"
},
"devDependencies": {
"jsdoc-to-markdown": "^7.1.1"
Expand Down
8 changes: 8 additions & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
docs: [{ type: 'autogenerated', dirName: '.' }],
};

module.exports = sidebars;


21 changes: 21 additions & 0 deletions website/src/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import React from 'react';
import Layout from '@theme/Layout';
import Link from '@docusaurus/Link';

export default function Home() {
return (
<Layout title="Accord Project" description="Accord Project Documentation">
<main style={{ padding: '3rem 1rem', maxWidth: 960, margin: '0 auto' }}>
<h1>Accord Project Documentation</h1>
<p>Welcome! Explore the docs using the sidebar or start here:</p>
<p>
<Link className="button button--primary" to="/accordproject">
Go to Overview
</Link>
</p>
</main>
</Layout>
);
}