docs.waku.org/docusaurus.config.js

204 lines
3.8 KiB
JavaScript
Raw Normal View History

2022-08-04 11:42:53 +00:00
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
feat: use Logos theme & plugin (#33) * Use Logos plugins and theme. * Upgrade dependencies. * feat: improvements on docs (#24) * add: security features * add: protocols overview by example * add: different protocols * add: spell check on CI * rm: yarn.lock to avoid inconsistencies * Update docs/Concepts/1.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/2.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/2.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/7.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * Update docs/Concepts/7.md Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * convert mscgen sequence to mermaid * partially adress review comments * address: comments * fix: ci * chore: address minor typos/changes in docs * add: pros/cons for discv5 and peer-exchange * fix: minor typo * chore: address refactoring Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com> * chore: refactor ordering/naming of markdown files (#29) * chore: rename md files and use config ordering it is unfeasible to track the changes in files labelled as '1.md', '2.md', etc and way easier when the files are named after their contents. * fix: hint box render * fix: markdown links * finish merge * push yarn.lock Co-authored-by: Hossein Mehrabi <ohyeaross@gmail.com> Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>
2023-01-23 09:37:39 +00:00
require("dotenv").config();
2022-08-04 11:42:53 +00:00
2023-05-19 23:35:51 +00:00
/** @type {import("@docusaurus/types").Config} */
2022-08-04 11:42:53 +00:00
const config = {
2023-05-25 16:48:57 +00:00
title: "Waku Docs Portal",
2023-05-19 23:35:51 +00:00
url: "https://waku.guide/",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
2022-08-04 11:42:53 +00:00
2023-05-19 23:35:51 +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",
locales: ["en"]
},
presets: [
[
"@acid-info/logos-docusaurus-preset",
({
businessUnit: "Waku",
customSiteConfig: true,
docs: {
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/waku-org/waku.guide/tree/develop/"
},
theme: {
name: "docusaurus-default",
options: {
customCss: [require.resolve("./src/css/custom.scss")]
}
}
})
]
],
staticDirectories: ["static"],
themeConfig: ({
docs: {
sidebar: {
hideable: false
}
},
navbar: {
title: "Waku",
logo: {
2023-05-20 22:09:10 +00:00
srcDark: "img/logo_white.svg"
2023-05-19 23:35:51 +00:00
},
2023-05-20 22:09:10 +00:00
hideOnScroll: true,
2023-05-19 23:35:51 +00:00
items: [
{
type: "docSidebar",
2023-05-20 04:23:47 +00:00
position: "right",
2023-05-19 23:35:51 +00:00
sidebarId: "main",
2023-06-02 17:25:07 +00:00
label: "About Waku"
2023-05-20 00:15:16 +00:00
},
{
type: "dropdown",
2023-06-06 02:47:24 +00:00
label: "Guides",
2023-05-20 04:23:47 +00:00
position: "right",
2023-05-20 00:15:16 +00:00
items: [
{
2023-06-08 12:28:25 +00:00
label: "Nodes and SDKs",
to: "/guides/nodes-and-sdks"
},
{
2023-06-09 19:32:04 +00:00
label: "Run a Nwaku Node",
2023-06-08 12:28:25 +00:00
to: "guides/run-nwaku-node"
2023-05-20 00:15:16 +00:00
}
]
2023-05-20 04:23:47 +00:00
},
{
to: "/powered-by-waku",
label: "Powered by Waku",
position: "right"
},
{
2023-05-22 12:35:34 +00:00
type: "dropdown",
2023-05-20 04:23:47 +00:00
label: "Community",
2023-05-22 12:35:34 +00:00
position: "right",
items: [
{
label: "Join Our Community",
to: "/community"
},
{
label: "Contribute to Waku",
to: "/contribute"
2023-05-24 17:29:24 +00:00
},
{
label: "Watch Our Presentations",
to: "/presentations"
2023-06-02 18:12:50 +00:00
},
{
2023-06-02 22:45:28 +00:00
label: "Bug Bounty Program",
2023-06-02 18:12:50 +00:00
href: "https://hackenproof.com/status-dot-im/waku"
2023-05-22 12:35:34 +00:00
}
]
2023-05-21 13:20:48 +00:00
},
{
href: "https://github.com/waku-org",
position: "right",
className: "header-github-link",
title: "Waku GitHub repository"
},
2023-05-19 23:35:51 +00:00
]
},
footer: {
2023-05-20 04:23:47 +00:00
links: [
{
2023-06-06 02:47:24 +00:00
title: "Guides",
2023-05-20 04:23:47 +00:00
items: [
{
2023-06-08 12:28:25 +00:00
to: "/guides/nodes-and-sdks",
label: "Nodes and SDKs"
},
{
2023-06-09 19:32:04 +00:00
label: "Run a Nwaku Node",
2023-06-08 12:28:25 +00:00
to: "guides/run-nwaku-node"
2023-05-20 04:23:47 +00:00
}
]
},
2023-05-19 23:35:51 +00:00
{
title: "Community",
2023-05-20 22:09:10 +00:00
items: [
{
2023-05-27 06:45:58 +00:00
href: "https://discord.waku.org/",
2023-05-19 23:35:51 +00:00
label: "Discord"
},
{
href: "https://twitter.com/waku_org",
label: "Twitter"
},
{
href: "https://t.me/waku_org",
label: "Telegram"
2023-05-27 06:45:58 +00:00
},
{
href: "https://forum.vac.dev/",
label: "Vac Forum"
2023-05-19 23:35:51 +00:00
}
]
},
{
title: "Resources",
2023-05-20 22:09:10 +00:00
items: [
{
href: "https://github.com/waku-org",
label: "GitHub"
},
2023-05-19 23:35:51 +00:00
{
href: "https://vac.dev/research",
label: "Blog"
},
{
href: "https://rfc.vac.dev/",
label: "Vac RFCs"
}
]
},
{
title: "Legal",
2023-05-20 22:09:10 +00:00
items: [
{
href: "https://waku.org/terms-of-use",
label: "Terms of Use"
},
2023-05-19 23:35:51 +00:00
{
href: "https://waku.org/privacy-policy",
label: "Privacy Policy"
2023-05-20 22:09:10 +00:00
},
{
2023-05-21 13:20:48 +00:00
html: "<link rel='stylesheet' href='/custom.css' />"
2023-05-19 23:35:51 +00:00
}
]
}
]
},
colorMode: {
defaultMode: "light",
disableSwitch: false,
respectPrefersColorScheme: false
}
}),
plugins: [
[
"@easyops-cn/docusaurus-search-local",
{
hashed: true,
indexDocs: true,
indexPages: true
}
]
],
themes: ["@docusaurus/theme-mermaid"],
markdown: {
mermaid: true
}
2022-08-04 11:42:53 +00:00
};
2023-05-19 23:35:51 +00:00
module.exports = config;