Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #44

Merged
merged 8 commits into from
Jul 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/odd-islands-cross.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@zayne-labs/callapi": patch
---

Add Documentation website
3 changes: 1 addition & 2 deletions tsconfig.eslint.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"compilerOptions": {
"composite": true
},

"include": ["src/**/*", "*", ".size-limit.ts"],
"include": ["src/**/*", "*", ".size-limit.ts", "website/**/*"],
"exclude": ["node_modules"]
}
Binary file added website/.github/image.webp
Binary file not shown.
Binary file added website/.github/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.next
node_modules
5 changes: 5 additions & 0 deletions website/next-env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
13 changes: 13 additions & 0 deletions website/next.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/* eslint-disable import-x/no-named-as-default */
/* eslint-disable import-x/no-named-as-default-member */
/* eslint-disable import-x/default */
import nextra from "nextra";

// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment
const withNextra = nextra({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
});

// eslint-disable-next-line @typescript-eslint/no-unsafe-call
export default withNextra();
26 changes: 26 additions & 0 deletions website/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"name": "docs",
"version": "0.0.0",
"description": "CallApi Docs",
"private": true,
"scripts": {
"dev": "next dev --port 3001",
"build": "next build",
"start": "next start"
},
"dependencies": {
"@vercel/analytics": "^1.1.1",
"next": "^13.5.6",
"nextra": "latest",
"nextra-theme-docs": "latest",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@types/node": "18.11.10",
"autoprefixer": "^10",
"postcss": "^8",
"tailwindcss": "^3",
"typescript": "^4.9.3"
}
}
11 changes: 11 additions & 0 deletions website/pages/_app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import "../styles/globals.css";
import { Analytics } from "@vercel/analytics/react";

export default function App({ Component, pageProps }) {
return (
<>
<Component {...pageProps} />
<Analytics />
</>
);
}
18 changes: 18 additions & 0 deletions website/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"index": "Introduction",
"getting-started": "Getting Started",
"features": "Core Features",
"advanced": "Advanced",
"api-reference": "API Reference",
"examples": "Examples",
"about": {
"title": "About",
"type": "page"
},
"contact": {
"title": "Contact ↗",
"type": "page",
"href": "https://twitter.com/xeuxdev",
"newWindow": true
}
}
4 changes: 4 additions & 0 deletions website/pages/about.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# About Easymailer

This is the about page! This page is shown on the navbar.
balablur hrher
Loading