Skip to content

Commit 00653a6

Browse files
committed
chore: updated the whole thing
0 parents  commit 00653a6

23 files changed

+13610
-0
lines changed

.gitignore

Lines changed: 20 additions & 0 deletions
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*

.prettierrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"trailingComma": "all",
3+
"tabWidth": 2,
4+
"semi": false,
5+
"singleQuote": true
6+
}

README.md

Lines changed: 41 additions & 0 deletions
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.

docusaurus.config.ts

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
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+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6+
7+
const config: Config = {
8+
title: 'PoliNetwork Docs',
9+
tagline: 'Technical documentation for PoliNetwork',
10+
favicon: 'img/favicon.ico',
11+
12+
url: 'https://docs.polinetwork.org',
13+
baseUrl: '/',
14+
organizationName: 'PoliNetwork',
15+
projectName: 'Docs',
16+
17+
onBrokenLinks: 'throw',
18+
onBrokenMarkdownLinks: 'warn',
19+
20+
i18n: {
21+
defaultLocale: 'en',
22+
locales: ['en'],
23+
},
24+
25+
presets: [
26+
[
27+
'classic',
28+
{
29+
docs: {
30+
sidebarPath: './sidebars.ts',
31+
// Please change this to your repo.
32+
// Remove this to remove the "edit this page" links.
33+
editUrl:
34+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
35+
},
36+
blog: {
37+
showReadingTime: true,
38+
feedOptions: {
39+
type: ['rss', 'atom'],
40+
xslt: true,
41+
},
42+
// Please change this to your repo.
43+
// Remove this to remove the "edit this page" links.
44+
editUrl:
45+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
46+
// Useful options to enforce blogging best practices
47+
onInlineTags: 'warn',
48+
onInlineAuthors: 'warn',
49+
onUntruncatedBlogPosts: 'warn',
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: 'My Site',
63+
logo: {
64+
alt: 'My Site Logo',
65+
src: 'img/logo.svg',
66+
},
67+
items: [
68+
{
69+
type: 'docSidebar',
70+
sidebarId: 'tutorialSidebar',
71+
position: 'left',
72+
label: 'Tutorial',
73+
},
74+
{ to: '/blog', label: 'Blog', position: 'left' },
75+
{
76+
href: 'https://github.com/facebook/docusaurus',
77+
label: 'GitHub',
78+
position: 'right',
79+
},
80+
],
81+
},
82+
footer: {
83+
style: 'dark',
84+
links: [
85+
{
86+
title: 'Docs',
87+
items: [
88+
{
89+
label: 'Tutorial',
90+
to: '/docs/intro',
91+
},
92+
],
93+
},
94+
{
95+
title: 'Community',
96+
items: [
97+
{
98+
label: 'Stack Overflow',
99+
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
100+
},
101+
{
102+
label: 'Discord',
103+
href: 'https://discordapp.com/invite/docusaurus',
104+
},
105+
{
106+
label: 'X',
107+
href: 'https://x.com/docusaurus',
108+
},
109+
],
110+
},
111+
{
112+
title: 'More',
113+
items: [
114+
{
115+
label: 'Blog',
116+
to: '/blog',
117+
},
118+
{
119+
label: 'GitHub',
120+
href: 'https://github.com/facebook/docusaurus',
121+
},
122+
],
123+
},
124+
],
125+
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
126+
},
127+
prism: {
128+
theme: prismThemes.github,
129+
darkTheme: prismThemes.dracula,
130+
},
131+
} satisfies Preset.ThemeConfig,
132+
}
133+
134+
export default config

eslint.config.mjs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import globals from 'globals'
2+
import pluginJs from '@eslint/js'
3+
import tseslint from 'typescript-eslint'
4+
import pluginReact from 'eslint-plugin-react'
5+
import prettier from 'eslint-config-prettier'
6+
7+
/** @type {import('eslint').Linter.Config[]} */
8+
export default [
9+
{ files: ['src/**/*.{ts,tsx}'] },
10+
{ languageOptions: { globals: globals.browser } },
11+
pluginJs.configs.recommended,
12+
...tseslint.configs.recommended,
13+
pluginReact.configs.flat['jsx-runtime'],
14+
prettier,
15+
{
16+
rules: {
17+
'@typescript-eslint/no-require-imports': 'off', // for requiring svgs
18+
},
19+
},
20+
{ ignores: ['**/.docusaurus/**'] },
21+
]

package.json

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{
2+
"name": "polinetworkdocs",
3+
"version": "0.0.0",
4+
"private": true,
5+
"scripts": {
6+
"docusaurus": "docusaurus",
7+
"start": "docusaurus start",
8+
"build": "docusaurus build",
9+
"swizzle": "docusaurus swizzle",
10+
"deploy": "docusaurus deploy",
11+
"clear": "docusaurus clear",
12+
"serve": "docusaurus serve",
13+
"write-translations": "docusaurus write-translations",
14+
"write-heading-ids": "docusaurus write-heading-ids",
15+
"typecheck": "tsc",
16+
"lint": "eslint .",
17+
"format": "prettier --write ."
18+
},
19+
"dependencies": {
20+
"@docusaurus/core": "3.7.0",
21+
"@docusaurus/preset-classic": "3.7.0",
22+
"@mdx-js/react": "^3.0.0",
23+
"clsx": "^2.0.0",
24+
"prism-react-renderer": "^2.3.0",
25+
"react": "^19.0.0",
26+
"react-dom": "^19.0.0"
27+
},
28+
"devDependencies": {
29+
"@docusaurus/module-type-aliases": "3.7.0",
30+
"@docusaurus/tsconfig": "3.7.0",
31+
"@docusaurus/types": "3.7.0",
32+
"@eslint/eslintrc": "^3.3.0",
33+
"@eslint/js": "^9.21.0",
34+
"eslint": "^9.21.0",
35+
"eslint-config-prettier": "^10.0.2",
36+
"eslint-plugin-react": "^7.37.4",
37+
"globals": "^16.0.0",
38+
"typescript": "~5.6.2",
39+
"typescript-eslint": "^8.25.0"
40+
},
41+
"browserslist": {
42+
"production": [
43+
">0.5%",
44+
"not dead",
45+
"not op_mini all"
46+
],
47+
"development": [
48+
"last 3 chrome version",
49+
"last 3 firefox version",
50+
"last 5 safari version"
51+
]
52+
},
53+
"engines": {
54+
"node": ">=18.0"
55+
}
56+
}

0 commit comments

Comments
 (0)