From c29e6ea861c1227751723607e17a3ae21c511d8c Mon Sep 17 00:00:00 2001 From: Catalin Pit <25515812+catalinpit@users.noreply.github.com> Date: Fri, 12 Apr 2024 14:40:39 +0300 Subject: [PATCH] chore: added frontmatter plus some changes --- apps/documentation/next.config.js | 2 +- apps/documentation/pages/_meta.json | 8 +++ .../pages/app/getting-started.mdx | 1 + .../pages/contributing/guide.mdx | 0 apps/documentation/pages/faq/faq.mdx | 1 + apps/documentation/pages/index.mdx | 4 +- .../pages/local-development/docker.mdx | 5 ++ .../pages/local-development/gitpod.mdx | 5 ++ .../pages/local-development/index.mdx | 5 ++ .../pages/local-development/manual.mdx | 5 ++ .../pages/local-development/quickstart.mdx | 5 ++ apps/documentation/theme.config.jsx | 25 ---------- apps/documentation/theme.config.tsx | 49 +++++++++++++++++++ 13 files changed, 87 insertions(+), 28 deletions(-) create mode 100644 apps/documentation/pages/app/getting-started.mdx create mode 100644 apps/documentation/pages/contributing/guide.mdx create mode 100644 apps/documentation/pages/faq/faq.mdx delete mode 100644 apps/documentation/theme.config.jsx create mode 100644 apps/documentation/theme.config.tsx diff --git a/apps/documentation/next.config.js b/apps/documentation/next.config.js index 718eb6bf2..9ae74fab6 100644 --- a/apps/documentation/next.config.js +++ b/apps/documentation/next.config.js @@ -3,7 +3,7 @@ const nextConfig = {}; const withNextra = require('nextra')({ theme: 'nextra-theme-docs', - themeConfig: './theme.config.jsx', + themeConfig: './theme.config.tsx', }); module.exports = withNextra(nextConfig); diff --git a/apps/documentation/pages/_meta.json b/apps/documentation/pages/_meta.json index 5aacf02e1..d0a2e0df9 100644 --- a/apps/documentation/pages/_meta.json +++ b/apps/documentation/pages/_meta.json @@ -7,6 +7,10 @@ "sidebar": false } }, + "app": { + "title": "Getting Started", + "type": "page" + }, "faq": { "title": "FAQ", "type": "page" @@ -23,6 +27,10 @@ "title": "Webhook", "type": "page" }, + "contributing": { + "title": "Contributing Guide", + "type": "page" + }, "---": { "type": "separator" }, diff --git a/apps/documentation/pages/app/getting-started.mdx b/apps/documentation/pages/app/getting-started.mdx new file mode 100644 index 000000000..bad55622f --- /dev/null +++ b/apps/documentation/pages/app/getting-started.mdx @@ -0,0 +1 @@ +# Getting Started diff --git a/apps/documentation/pages/contributing/guide.mdx b/apps/documentation/pages/contributing/guide.mdx new file mode 100644 index 000000000..e69de29bb diff --git a/apps/documentation/pages/faq/faq.mdx b/apps/documentation/pages/faq/faq.mdx new file mode 100644 index 000000000..4514b4c10 --- /dev/null +++ b/apps/documentation/pages/faq/faq.mdx @@ -0,0 +1 @@ +# FAQ diff --git a/apps/documentation/pages/index.mdx b/apps/documentation/pages/index.mdx index 6b6d553de..b082f403d 100644 --- a/apps/documentation/pages/index.mdx +++ b/apps/documentation/pages/index.mdx @@ -18,7 +18,7 @@ Documenso aims to be the world's most trusted document-signing tool. This trust Join us in creating the next generation of open trust infrastructure. -## Our tech stack is as follows: +## Our tech stack: - [Typescript](https://www.typescriptlang.org/) - Language - [Next.js](https://nextjs.org/) - Framework @@ -34,7 +34,7 @@ Join us in creating the next generation of open trust infrastructure. - [Stripe](https://stripe.com/) - Payments - [Vercel](https://vercel.com) - Hosting -
+
**Note**: This is a quickstart for developers. It assumes that you have both [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/) installed on your machine. diff --git a/apps/documentation/theme.config.jsx b/apps/documentation/theme.config.jsx deleted file mode 100644 index ec6575e8c..000000000 --- a/apps/documentation/theme.config.jsx +++ /dev/null @@ -1,25 +0,0 @@ -const themeConfig = { - logo: Documenso, - project: { - link: 'https://documen.so/github', - }, - chat: { - link: 'https://documen.so/discord', - }, - docsRepositoryBase: 'https://github.com/documenso/documenso/tree/main/apps/documentation', - footer: { - text: ( - - {new Date().getFullYear()} ©{' '} - - Documenso - - . - - ), - }, - primaryHue: 100, - primarySaturation: 48.47, -}; - -export default themeConfig; diff --git a/apps/documentation/theme.config.tsx b/apps/documentation/theme.config.tsx new file mode 100644 index 000000000..fd4c4d181 --- /dev/null +++ b/apps/documentation/theme.config.tsx @@ -0,0 +1,49 @@ +import { useConfig } from 'nextra-theme-docs'; +import type { DocsThemeConfig } from 'nextra-theme-docs'; + +const themeConfig: DocsThemeConfig = { + logo: Documenso, + head: function useHead() { + const config = useConfig<{ title?: string; description?: string }>(); + + const title = `${config.frontMatter.title} | Documenso Docs` || 'Documenso Docs'; + const description = config.frontMatter.description || 'The official Documenso documentation'; + + return ( + <> + + + + + + + ); + }, + project: { + link: 'https://documen.so/github', + }, + chat: { + link: 'https://documen.so/discord', + }, + docsRepositoryBase: 'https://github.com/documenso/documenso/tree/main/apps/documentation', + footer: { + text: ( + + {new Date().getFullYear()} ©{' '} + + Documenso + + . + + ), + }, + primaryHue: 100, + primarySaturation: 48.47, + useNextSeoProps() { + return { + titleTemplate: '%s | Documenso Docs', + }; + }, +}; + +export default themeConfig;