Skip to content

Commit 69b16e4

Browse files
committed
initial commit with docusaurs, no content yet
1 parent 7b97983 commit 69b16e4

12 files changed

+14902
-0
lines changed

Diff for: .gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

Diff for: README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

Diff for: babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

Diff for: docs/intro.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Test intro

Diff for: docusaurus.config.ts

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
import { themes as prismThemes } from "prism-react-renderer";
2+
import type { Config } from "@docusaurus/types";
3+
import type * as Preset from "@docusaurus/preset-classic";
4+
5+
const config: Config = {
6+
title: "Plebbit docs",
7+
tagline: "A decentralized P2P social media protocol",
8+
favicon:
9+
"https://raw.githubusercontent.com/plebbit/assets/master/logo-square.svg",
10+
11+
// Set the production url of your site here
12+
url: "https://plebbit.github.io",
13+
// Set the /<baseUrl>/ pathname under which your site is served
14+
// For GitHub pages deployment, it is often '/<projectName>/'
15+
baseUrl: "/",
16+
17+
// GitHub pages deployment config.
18+
// If you aren't using GitHub pages, you don't need these.
19+
organizationName: "plebbit", // Usually your GitHub org/user name.
20+
projectName: "plebbit-docs", // Usually your repo name.
21+
22+
onBrokenLinks: "throw",
23+
onBrokenMarkdownLinks: "warn",
24+
25+
// Even if you don't use internationalization, you can use this field to set
26+
// useful metadata like html lang. For example, if your site is Chinese, you
27+
// may want to replace "en" with "zh-Hans".
28+
i18n: {
29+
defaultLocale: "en",
30+
locales: ["en"],
31+
},
32+
33+
presets: [
34+
[
35+
"classic",
36+
{
37+
docs: {
38+
sidebarPath: "./sidebars.ts",
39+
// Please change this to your repo.
40+
// Remove this to remove the "edit this page" links.
41+
editUrl:
42+
"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
43+
},
44+
blog: {
45+
showReadingTime: true,
46+
// Please change this to your repo.
47+
// Remove this to remove the "edit this page" links.
48+
editUrl:
49+
"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
50+
},
51+
theme: {
52+
customCss: "./src/css/custom.css",
53+
},
54+
} satisfies Preset.Options,
55+
],
56+
],
57+
58+
themeConfig: {
59+
// Replace with your project's social card
60+
image: "img/docusaurus-social-card.jpg",
61+
navbar: {
62+
title: "Plebbit",
63+
logo: {
64+
alt: "Plebbit Logo",
65+
src: "https://raw.githubusercontent.com/plebbit/assets/master/logo-square.svg",
66+
},
67+
items: [
68+
{
69+
type: "docSidebar",
70+
sidebarId: "tutorialSidebar",
71+
position: "left",
72+
label: "Docs",
73+
},
74+
{
75+
href: "https://github.com/plebbit",
76+
label: "GitHub",
77+
position: "right",
78+
},
79+
],
80+
},
81+
footer: {
82+
style: "dark",
83+
links: [
84+
{
85+
title: "Docs",
86+
items: [
87+
{
88+
label: "Tutorial",
89+
to: "/docs/intro",
90+
},
91+
],
92+
},
93+
{
94+
title: "Community",
95+
items: [
96+
{
97+
label: "Landing page",
98+
href: "https://plebbit.com",
99+
},
100+
{
101+
label: "Discord",
102+
href: "https://discord.gg/E7ejphwzGW",
103+
},
104+
{
105+
label: "Twitter",
106+
href: "https://twitter.com/getplebbit",
107+
},
108+
{
109+
label: "Telegram",
110+
href: "https://t.me/plebbit",
111+
},
112+
],
113+
},
114+
{
115+
title: "More",
116+
items: [
117+
{
118+
label: "Blog",
119+
to: "/blog",
120+
},
121+
{
122+
label: "GitHub",
123+
href: "https://github.com/plebbit",
124+
},
125+
],
126+
},
127+
],
128+
copyright: `All of Plebbit repos are under GPL V2 license`,
129+
},
130+
prism: {
131+
theme: prismThemes.github,
132+
darkTheme: prismThemes.dracula,
133+
},
134+
} satisfies Preset.ThemeConfig,
135+
};
136+
137+
export default config;

0 commit comments

Comments
 (0)