Skip to content

Commit 61c20a0

Browse files
committed
Initial Docusaurus Site (Blank)
1 parent f1af438 commit 61c20a0

15 files changed

+15047
-0
lines changed

docs-site/.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*

docs-site/README.md

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

docs-site/babel.config.js

Lines changed: 3 additions & 0 deletions
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+
};

docs-site/docs/intro.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Intentionally Blank

docs-site/docusaurus.config.js

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
// @ts-check
2+
// `@type` JSDoc annotations allow editor autocompletion and type checking
3+
// (when paired with `@ts-check`).
4+
// There are various equivalent ways to declare your Docusaurus config.
5+
// See: https://docusaurus.io/docs/api/docusaurus-config
6+
7+
import {themes as prismThemes} from 'prism-react-renderer';
8+
9+
/** @type {import('@docusaurus/types').Config} */
10+
const config = {
11+
title: 'Blobs - Documentation',
12+
tagline: 'Blobchains on Polkadot and Kusama',
13+
favicon: 'img/favicon.ico',
14+
15+
// Set the production url of your site here
16+
url: 'https://your-docusaurus-site.example.com',
17+
// Set the /<baseUrl>/ pathname under which your site is served
18+
// For GitHub pages deployment, it is often '/<projectName>/'
19+
baseUrl: '/',
20+
21+
// GitHub pages deployment config.
22+
// If you aren't using GitHub pages, you don't need these.
23+
organizationName: 'ThrumDev', // Usually your GitHub org/user name.
24+
projectName: 'blobs', // Usually your repo name.
25+
26+
onBrokenLinks: 'throw',
27+
onBrokenMarkdownLinks: 'warn',
28+
29+
// Even if you don't use internationalization, you can use this field to set
30+
// useful metadata like html lang. For example, if your site is Chinese, you
31+
// may want to replace "en" with "zh-Hans".
32+
i18n: {
33+
defaultLocale: 'en',
34+
locales: ['en'],
35+
},
36+
37+
presets: [
38+
[
39+
'classic',
40+
/** @type {import('@docusaurus/preset-classic').Options} */
41+
({
42+
docs: {
43+
sidebarPath: './sidebars.js',
44+
// Please change this to your repo.
45+
// Remove this to remove the "edit this page" links.
46+
editUrl:
47+
'https://github.com/thrumdev/blobs/tree/main/docs-site',
48+
},
49+
blog: false,
50+
theme: {
51+
customCss: './src/css/custom.css',
52+
},
53+
}),
54+
],
55+
],
56+
57+
themeConfig:
58+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
59+
({
60+
// Replace with your project's social card
61+
image: 'img/docusaurus-social-card.jpg',
62+
navbar: {
63+
title: 'Blobs',
64+
logo: {
65+
alt: 'My Site Logo',
66+
src: 'img/logo.svg',
67+
},
68+
items: [
69+
{
70+
type: 'docSidebar',
71+
sidebarId: 'docsSidebar',
72+
position: 'left',
73+
label: 'Documentation',
74+
},
75+
{
76+
href: 'https://github.com/thrumdev/blobs',
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: 'Documentation',
90+
to: '/docs/intro',
91+
},
92+
],
93+
},
94+
{
95+
title: 'Community',
96+
items: [
97+
{
98+
label: 'Twitter',
99+
href: 'https://twitter.com/thrumdev',
100+
},
101+
],
102+
},
103+
{
104+
title: 'More',
105+
items: [
106+
{
107+
label: 'Our Website',
108+
href: 'https://thrum.dev',
109+
},
110+
{
111+
label: 'GitHub',
112+
href: 'https://github.com/thrumdev/blobs',
113+
},
114+
],
115+
},
116+
],
117+
copyright: `Copyright © ${new Date().getFullYear()} Thrum Supersystems, LLC. Built with Docusaurus.`,
118+
},
119+
prism: {
120+
theme: prismThemes.github,
121+
darkTheme: prismThemes.dracula,
122+
},
123+
}),
124+
};
125+
126+
export default config;

0 commit comments

Comments
 (0)