chore: added frontmatter plus some changes

This commit is contained in:
Catalin Pit
2024-04-12 14:40:39 +03:00
parent 1f71baaffb
commit c29e6ea861
13 changed files with 87 additions and 28 deletions

View File

@ -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);

View File

@ -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"
},

View File

@ -0,0 +1 @@
# Getting Started

View File

@ -0,0 +1 @@
# FAQ

View File

@ -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
<div class="mt-16 flex items-center justify-center gap-4">
<div className="mt-16 flex items-center justify-center gap-4">
<a href="https://documen.so/discord">
<img
src="https://img.shields.io/badge/Discord-documen.so/discord-%235865F2"

View File

@ -1,3 +1,8 @@
---
title: Docker Development
description: Set up Documenso using Docker for local development.
---
# Docker
We provide a Docker container for Documenso, which is published on both DockerHub and GitHub Container Registry.

View File

@ -1,3 +1,8 @@
---
title: Run in Gitpod
description: Get started with Documenso in a ready-to-use Gitpod workspace in your browser.
---
# Run in Gitpod
- Click below to launch a ready-to-use Gitpod workspace in your browser.

View File

@ -1,3 +1,8 @@
---
title: Local development
description: Learn how to set up Documenso for local development.
---
# Local development
There are multiple ways of setting up Documenso for local development. At the moment of writing this documentation, there are 4 ways of running Documenso locally:

View File

@ -1,3 +1,8 @@
---
title: Manual Setup
description: Manually set up Documenso on your machine for local development.
---
# Manual Setup
Follow these steps to setup Documenso on your local machine:

View File

@ -1,3 +1,8 @@
---
title: Developer Quickstart
description: Quickly set up Documenso on your machine for local development with Docker and Docker Compose.
---
# Developer Quickstart
> **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.

View File

@ -1,25 +0,0 @@
const themeConfig = {
logo: <span>Documenso</span>,
project: {
link: 'https://documen.so/github',
},
chat: {
link: 'https://documen.so/discord',
},
docsRepositoryBase: 'https://github.com/documenso/documenso/tree/main/apps/documentation',
footer: {
text: (
<span>
{new Date().getFullYear()} ©{' '}
<a href="https://documen.so" target="_blank">
Documenso
</a>
.
</span>
),
},
primaryHue: 100,
primarySaturation: 48.47,
};
export default themeConfig;

View File

@ -0,0 +1,49 @@
import { useConfig } from 'nextra-theme-docs';
import type { DocsThemeConfig } from 'nextra-theme-docs';
const themeConfig: DocsThemeConfig = {
logo: <span>Documenso</span>,
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 (
<>
<meta httpEquiv="Content-Language" content="en" />
<meta name="title" content={title} />
<meta name="og:title" content={title} />
<meta name="description" content={description} />
<meta name="og:description" content={description} />
</>
);
},
project: {
link: 'https://documen.so/github',
},
chat: {
link: 'https://documen.so/discord',
},
docsRepositoryBase: 'https://github.com/documenso/documenso/tree/main/apps/documentation',
footer: {
text: (
<span>
{new Date().getFullYear()} ©{' '}
<a href="https://documen.so" target="_blank">
Documenso
</a>
.
</span>
),
},
primaryHue: 100,
primarySaturation: 48.47,
useNextSeoProps() {
return {
titleTemplate: '%s | Documenso Docs',
};
},
};
export default themeConfig;