mirror of
https://github.com/waku-org/docs.waku.org.git
synced 2025-02-23 02:08:07 +00:00
dd5709e779
* 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>
56 lines
1.4 KiB
JavaScript
56 lines
1.4 KiB
JavaScript
// @ts-check
|
|
// Note: type annotations allow type checking and IDEs autocompletion
|
|
require("dotenv").config();
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: "Waku Guides",
|
|
url: "https://waku.guide/",
|
|
baseUrl: "/",
|
|
onBrokenLinks: "throw",
|
|
onBrokenMarkdownLinks: "warn",
|
|
|
|
// 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",
|
|
/** @type {import('@acid-info/logos-docusaurus-preset').PluginOptions} */
|
|
({
|
|
businessUnit: "Waku",
|
|
customSiteConfig: true,
|
|
docs: {
|
|
routeBasePath: "/",
|
|
sidebarPath: require.resolve("./sidebars.js"),
|
|
// Please change this to your repo.
|
|
// Remove this to remove the "edit this page" links.
|
|
editUrl: "https://github.com/waku-org/waku.guide/tree/staging/",
|
|
},
|
|
theme: {
|
|
name: "default",
|
|
options: {
|
|
customCss: [require.resolve("./src/css/custom.scss")],
|
|
},
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
|
|
themeConfig:
|
|
/** @type {import('@acid-info/logos-docusaurus-preset').ThemeConfig} */
|
|
({}),
|
|
|
|
themes: ["@docusaurus/theme-mermaid"],
|
|
markdown: {
|
|
mermaid: true,
|
|
},
|
|
};
|
|
|
|
module.exports = config;
|