Skip to content

Commit

Permalink
feat: initial structure
Browse files Browse the repository at this point in the history
  • Loading branch information
pepeladeira committed Mar 27, 2024
0 parents commit 4403b91
Show file tree
Hide file tree
Showing 18 changed files with 15,134 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ npm install
```

### Local Development

```
$ npm start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
8 changes: 8 additions & 0 deletions docs/api/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "API",
"position": 2,
"link": {
"type": "generated-index",
"description": "API Reference"
}
}
5 changes: 5 additions & 0 deletions docs/api/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Getting Started
6 changes: 6 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 1
---

# Introduction

122 changes: 122 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config

import { themes as prismThemes } from "prism-react-renderer";

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Pingback for Developers",
tagline: "From Developers to Developers",
favicon: "img/favicon.ico",

// Set the production url of your site here
url: "https://developers.pingback.com",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "getpingback", // Usually your GitHub org/user name.
projectName: "pingback-for-devs", // Usually your repo name.

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",

// Even if you don't use internationalization, 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: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: "./sidebars.js",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/getpingback/pingback-for-devs/tree/master/",
},
blog: false,
theme: {
customCss: "./src/css/custom.css",
},
}),
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: "img/pingback-for-devs.png",
navbar: {
logo: {
alt: "Pingback Logo",
src: "img/logo-dark.svg",
srcDark: "img/logo-white.svg",
},
items: [
{
href: "https://github.com/getpingback/pingback-for-devs",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
],
},
footer: {
style: "light",
links: [
{
title: "Documentation",
items: [
{
label: "API",
to: "/docs/intro",
},
{
label: "Embed",
to: "/docs/intro",
},
{
label: "Email Verification",
to: "/docs/intro",
},
],
},
{
title: "Community",
items: [
{
label: "Newsroom",
href: "https://pingback.com/newsroom",
},
{
label: "GitHub",
href: "https://github.com/getpingback",
},
{
label: "Twitter",
href: "https://twitter.com/pingbackoficial",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Pingback. Built with 💜 for Developers.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
}),
};

export default config;
Loading

0 comments on commit 4403b91

Please sign in to comment.