docs.cwtch.im/docusaurus.config.js

218 lines
5.7 KiB
JavaScript
Raw Permalink Normal View History

2022-05-11 20:53:53 +00:00
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
2023-03-07 20:36:38 +00:00
const math = require('remark-math');
const katex = require('rehype-katex');
2022-05-11 20:53:53 +00:00
/** @type {import('@docusaurus/types').Config} */
const config = {
2022-06-03 13:45:27 +00:00
title: 'The Cwtch Handbook',
2022-06-17 20:25:16 +00:00
tagline: 'Your Guide to setting up, and using, Surveillance Resistant Infrastructure',
2022-05-11 22:03:40 +00:00
url: 'https://docs.cwtch.im',
2022-05-11 20:53:53 +00:00
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
2022-05-24 23:38:59 +00:00
favicon: 'img/favicon.png',
2022-05-11 20:53:53 +00:00
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
2022-05-11 22:03:40 +00:00
organizationName: 'Open Privacy Research Society', // Usually your GitHub org/user name.
projectName: 'cwtch.im', // Usually your repo name.
2022-05-11 20:53:53 +00:00
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
2022-08-23 16:48:44 +00:00
locales: ['en', 'es', 'de', 'it']
2022-05-25 00:33:25 +00:00
// Planned future versions to add. removing to start cus each needs a compile on push, no point compiling untranslated dups
//, 'fr', 'da', 'de', 'it', 'no', 'pl', 'ro', 'ru', 'es-ES', 'cy'],
2022-05-11 20:53:53 +00:00
},
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
2023-06-16 19:56:26 +00:00
'https://git.openprivacy.ca/cwtch.im/docs.cwtch.im/src/branch/staging/',
2023-03-07 20:36:38 +00:00
remarkPlugins: [math],
rehypePlugins: [katex],
2022-05-11 20:53:53 +00:00
},
2022-12-30 18:57:13 +00:00
blog: {
2023-01-04 17:48:40 +00:00
feedOptions: {
type: 'all',
copyright: 'Copyright © ${new Date().getFullYear()} Open Privacy Research Society',
title: 'Cwtch Development Log',
description: 'The latest insight into Cwtch Development and what the Cwtch team are working on',
},
2023-02-17 21:03:16 +00:00
blogSidebarCount: 20,
2022-12-30 18:57:13 +00:00
},
2022-05-11 20:53:53 +00:00
theme: {
customCss: require.resolve('./src/css/custom.css'),
2023-03-07 20:36:38 +00:00
2022-05-11 20:53:53 +00:00
},
2023-03-07 20:36:38 +00:00
2022-05-11 20:53:53 +00:00
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
2022-06-17 20:38:42 +00:00
image: 'img/cwtch_handbook_header.jpg',
2022-05-11 22:03:40 +00:00
colorMode: {
defaultMode: 'dark',
},
2022-05-11 20:53:53 +00:00
navbar: {
2022-05-18 16:43:12 +00:00
title: 'Cwtch Handbook',
2022-05-11 20:53:53 +00:00
logo: {
2022-05-18 16:43:12 +00:00
alt: 'Cwtch Logo',
src: 'img/knott.png'
2022-05-11 20:53:53 +00:00
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
2022-05-18 16:43:12 +00:00
label: 'Cwtch Intro',
2022-05-11 20:53:53 +00:00
},
2023-03-06 19:57:17 +00:00
{
to: '/security/intro',
position: 'left',
label: 'Security Handbook',
},
2023-04-24 19:29:13 +00:00
{
to: '/developing/intro',
position: 'left',
label: 'Developers Handbook',
},
2022-12-30 18:57:13 +00:00
{
to: 'blog',
position: 'left',
label: 'Development Log',
},
2023-01-03 18:11:26 +00:00
{
href: 'https://openprivacy.ca/donate',
label: 'Donate',
position: 'right',
},
{
href: 'https://patreon.com/openprivacy',
label: 'Patreon',
position: 'right',
},
2022-05-11 20:53:53 +00:00
{
href: 'https://cwtch.im/download',
label: 'Download',
2022-05-11 20:53:53 +00:00
position: 'right',
},
2022-05-19 00:43:31 +00:00
{
type: 'localeDropdown',
position: 'right',
},
2022-05-11 20:53:53 +00:00
],
},
2023-03-07 20:36:38 +00:00
2022-05-11 20:53:53 +00:00
footer: {
links: [
{
title: 'Docs',
items: [
{
2023-01-03 18:11:26 +00:00
label: 'Introduction',
2022-05-11 20:53:53 +00:00
to: '/docs/intro',
},
2023-03-06 20:10:34 +00:00
{
to: '/security/intro',
label: 'Security Handbook',
},
2023-04-24 19:29:13 +00:00
{
to: '/developing/intro',
label: 'Developer Guide',
},
2022-05-11 20:53:53 +00:00
],
},
{
title: 'Community',
items: [
2022-12-30 18:57:13 +00:00
{
label: 'Mastodon',
href: 'https://fosstodon.org/@cwtch',
},
2022-05-11 20:53:53 +00:00
{
label: 'Twitter',
2022-05-11 22:03:40 +00:00
href: 'https://twitter.com/cwtch_im',
2022-05-11 20:53:53 +00:00
},
],
},
{
2023-01-03 18:11:26 +00:00
title: 'Contribute',
2022-05-11 20:53:53 +00:00
items: [
{
2023-01-03 18:11:26 +00:00
label: 'Donate',
href: 'https://openprivacy.ca/donate',
},
{
label: 'Patreon',
href: 'https://patreon.com/openprivacy',
2022-05-11 20:53:53 +00:00
},
{
2023-01-03 18:11:26 +00:00
label: 'Source Code',
2022-05-11 22:03:40 +00:00
href: 'https://git.openprivacy.ca/cwtch.im',
2022-05-11 20:53:53 +00:00
},
{
label: 'Download',
href: 'https://cwtch.im/download',
},
2022-05-11 20:53:53 +00:00
],
},
],
2022-06-02 16:52:03 +00:00
copyright: `Copyright © ${new Date().getFullYear()} Open Privacy Research Society.`,
2022-05-11 20:53:53 +00:00
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
2023-03-06 19:57:17 +00:00
plugins: [
2022-05-11 20:53:53 +00:00
[
2023-03-06 19:57:17 +00:00
'@docusaurus/plugin-content-docs',
2022-05-11 20:53:53 +00:00
{
2023-03-06 19:57:17 +00:00
id: 'docs-security',
path: 'security',
routeBasePath: 'security',
sidebarPath: require.resolve('./sidebars.js'),
2023-03-07 20:36:38 +00:00
remarkPlugins: [math],
rehypePlugins: [katex],
2022-05-11 20:53:53 +00:00
},
],
2023-04-24 19:29:13 +00:00
[
'@docusaurus/plugin-content-docs',
{
id: 'docs-developer',
path: 'developing',
routeBasePath: 'developing',
sidebarPath: require.resolve('./sidebars.js'),
remarkPlugins: [math],
rehypePlugins: [katex],
},
],
2023-03-06 19:57:17 +00:00
],
2023-03-07 20:36:38 +00:00
stylesheets: [
{
href: '/katex/katex.min.css',
type: 'text/css',
},
],
2022-05-11 20:53:53 +00:00
};
module.exports = config;