chore: added frontmatter plus some changes
This commit is contained in:
@@ -3,7 +3,7 @@ const nextConfig = {};
|
|||||||
|
|
||||||
const withNextra = require('nextra')({
|
const withNextra = require('nextra')({
|
||||||
theme: 'nextra-theme-docs',
|
theme: 'nextra-theme-docs',
|
||||||
themeConfig: './theme.config.jsx',
|
themeConfig: './theme.config.tsx',
|
||||||
});
|
});
|
||||||
|
|
||||||
module.exports = withNextra(nextConfig);
|
module.exports = withNextra(nextConfig);
|
||||||
|
|||||||
@@ -7,6 +7,10 @@
|
|||||||
"sidebar": false
|
"sidebar": false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"app": {
|
||||||
|
"title": "Getting Started",
|
||||||
|
"type": "page"
|
||||||
|
},
|
||||||
"faq": {
|
"faq": {
|
||||||
"title": "FAQ",
|
"title": "FAQ",
|
||||||
"type": "page"
|
"type": "page"
|
||||||
@@ -23,6 +27,10 @@
|
|||||||
"title": "Webhook",
|
"title": "Webhook",
|
||||||
"type": "page"
|
"type": "page"
|
||||||
},
|
},
|
||||||
|
"contributing": {
|
||||||
|
"title": "Contributing Guide",
|
||||||
|
"type": "page"
|
||||||
|
},
|
||||||
"---": {
|
"---": {
|
||||||
"type": "separator"
|
"type": "separator"
|
||||||
},
|
},
|
||||||
|
|||||||
1
apps/documentation/pages/app/getting-started.mdx
Normal file
1
apps/documentation/pages/app/getting-started.mdx
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# Getting Started
|
||||||
0
apps/documentation/pages/contributing/guide.mdx
Normal file
0
apps/documentation/pages/contributing/guide.mdx
Normal file
1
apps/documentation/pages/faq/faq.mdx
Normal file
1
apps/documentation/pages/faq/faq.mdx
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# FAQ
|
||||||
@@ -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.
|
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
|
- [Typescript](https://www.typescriptlang.org/) - Language
|
||||||
- [Next.js](https://nextjs.org/) - Framework
|
- [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
|
- [Stripe](https://stripe.com/) - Payments
|
||||||
- [Vercel](https://vercel.com) - Hosting
|
- [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">
|
<a href="https://documen.so/discord">
|
||||||
<img
|
<img
|
||||||
src="https://img.shields.io/badge/Discord-documen.so/discord-%235865F2"
|
src="https://img.shields.io/badge/Discord-documen.so/discord-%235865F2"
|
||||||
|
|||||||
@@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: Docker Development
|
||||||
|
description: Set up Documenso using Docker for local development.
|
||||||
|
---
|
||||||
|
|
||||||
# Docker
|
# Docker
|
||||||
|
|
||||||
We provide a Docker container for Documenso, which is published on both DockerHub and GitHub Container Registry.
|
We provide a Docker container for Documenso, which is published on both DockerHub and GitHub Container Registry.
|
||||||
|
|||||||
@@ -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
|
# Run in Gitpod
|
||||||
|
|
||||||
- Click below to launch a ready-to-use Gitpod workspace in your browser.
|
- Click below to launch a ready-to-use Gitpod workspace in your browser.
|
||||||
|
|||||||
@@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: Local development
|
||||||
|
description: Learn how to set up Documenso for local development.
|
||||||
|
---
|
||||||
|
|
||||||
# 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:
|
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:
|
||||||
|
|||||||
@@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: Manual Setup
|
||||||
|
description: Manually set up Documenso on your machine for local development.
|
||||||
|
---
|
||||||
|
|
||||||
# Manual Setup
|
# Manual Setup
|
||||||
|
|
||||||
Follow these steps to setup Documenso on your local machine:
|
Follow these steps to setup Documenso on your local machine:
|
||||||
|
|||||||
@@ -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
|
# 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.
|
> **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.
|
||||||
|
|||||||
@@ -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;
|
|
||||||
49
apps/documentation/theme.config.tsx
Normal file
49
apps/documentation/theme.config.tsx
Normal 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;
|
||||||
Reference in New Issue
Block a user