Skip to content

Commit 45876db

Browse files
pradelpradel
authored
feat: first version with docusaurus (#1)
1 parent 0041d87 commit 45876db

22 files changed

+9235
-1
lines changed

‎.github/workflows/nodejs.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Node CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-20.04
12+
strategy:
13+
matrix:
14+
node-version: [16]
15+
16+
steps:
17+
- uses: actions/checkout@v1
18+
19+
- uses: pnpm/[email protected]
20+
with:
21+
version: 6.29.0
22+
23+
- name: Use Node.js ${{ matrix.node-version }}
24+
uses: actions/setup-node@v2
25+
with:
26+
node-version: ${{ matrix.node-version }}
27+
cache: 'pnpm'
28+
29+
- name: Install Dependencies
30+
run: pnpm install
31+
32+
- name: Typecheck
33+
run: pnpm run typecheck
34+
35+
- name: Build
36+
run: pnpm run build

‎.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*

‎.husky/.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.docusaurus
2+
build

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
pnpx lint-staged

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16

‎README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
# docs
1+
# Website
2+
3+
This website is built using [Docusaurus 2](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.

‎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+
};

‎docs/faq.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 2
3+
sidebar_label: FAQ
4+
---
5+
6+
# FAQ
7+
8+
## Who is behind Sigle?
9+
10+
Sigle was created by [Leo](https://twitter.com/leopradel), [Quentin](https://twitter.com/QuentinSaubadu) and [Arturs](https://twitter.com/akirtovskis), all passionate about decentralization.
11+
12+
## Where is my data stored?
13+
14+
When you write on Sigle, all of your data is stocked on a blockchain hub created by Blockstack called Gaia. Gaia’s approach to decentralization focuses on user control over data and its storage. If you want to learn more about Blockstack and Gaia, we invite you to [follow this link](https://docs.stacks.co/build-apps/references/gaia).
15+
16+
## Is Sigle free?
17+
18+
Sigle is totally free at the moment. We are working on a paid version of Sigle that will bring premium features.
19+
20+
## Feedback
21+
22+
To help us improve Sigle, [vote for the features](https://sigle.canny.io/feature-requests) you would like us to add!
23+
24+
## Support
25+
26+
If you are facing any issues with Sigle or just want to become part of the community, [join our Discord](https://discord.gg/td7WmgK22k).

‎docs/intro.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
slug: /
3+
sidebar_position: 1
4+
sidebar_label: Introduction
5+
---
6+
7+
# What is Sigle?
8+
9+
![Introduction illustration](/img/illustrations/login.png)
10+
11+
Sigle is a decentralised and open-source Web 3.0 writing platform made for writers.
12+
13+
We have created Sigle to thwart the big corporate industries that sell your data against your consent to make money on your back.
14+
We are focusing on protecting your privacy. Using a decentralised protocol and running top of Stacks, we will give you the possibility to store and lock your writing literally forever.

‎docs/links.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Official links
6+
7+
- [Application](https://app.sigle.io/)
8+
- [Landing page](https://www.sigle.io/)
9+
- [Blog](https://app.sigle.io/sigleapp.id.blockstack/)
10+
- [Feedback](https://sigle.canny.io/feature-requests/)
11+
12+
## Social
13+
14+
- Follow us on Twitter [@sigleapp](https://twitter.com/sigleapp)
15+
- Join the [Discord](https://discord.gg/td7WmgK22k)
16+
- Source code available on [GitHub](https://github.com/sigle)
17+
18+
## The Explorer Guild
19+
20+
3 000 NFT unique and randomly generated NFTs on the Stacks blockchain. Hand drawn and inspired by the famous writer Jules Verne.
21+
22+
- [Landing page](https://www.explorerguild.io/)
23+
- [Buy on STXNFT](https://stxnft.com/collections/SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild/)
24+
25+
## Other projects
26+
27+
- [StxStats](https://www.stxstats.co/): Get the latest data from Stacks blockchain.

‎docs/tutorial-basics/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Tutorial - Basics",
3+
"position": 3,
4+
"collapsed": false
5+
}

‎docs/tutorial-basics/create-a-page.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Create a Page
6+
7+
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
8+
9+
- `src/pages/index.js` -> `localhost:3000/`
10+
- `src/pages/foo.md` -> `localhost:3000/foo`
11+
- `src/pages/foo/bar.js` -> `localhost:3000/foo/bar`
12+
13+
## Create your first React Page
14+
15+
Create a file at `src/pages/my-react-page.js`:
16+
17+
```jsx title="src/pages/my-react-page.js"
18+
import React from 'react';
19+
import Layout from '@theme/Layout';
20+
21+
export default function MyReactPage() {
22+
return (
23+
<Layout>
24+
<h1>My React page</h1>
25+
<p>This is a React page</p>
26+
</Layout>
27+
);
28+
}
29+
```
30+
31+
A new page is now available at `http://localhost:3000/my-react-page`.
32+
33+
## Create your first Markdown Page
34+
35+
Create a file at `src/pages/my-markdown-page.md`:
36+
37+
```mdx title="src/pages/my-markdown-page.md"
38+
# My Markdown page
39+
40+
This is a Markdown page
41+
```
42+
43+
A new page is now available at `http://localhost:3000/my-markdown-page`.

‎docusaurus.config.js

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
// @ts-check
2+
3+
const lightCodeTheme = require('prism-react-renderer/themes/github');
4+
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
5+
6+
// TODO setup fathom
7+
// TODO migrate content from Gitbook
8+
// TODO meta SEO
9+
10+
/** @type {import('@docusaurus/types').Config} */
11+
const config = {
12+
title: 'Sigle',
13+
url: 'https://docs.sigle.io',
14+
baseUrl: '/',
15+
onBrokenLinks: 'throw',
16+
onBrokenMarkdownLinks: 'throw',
17+
favicon: 'img/favicon.ico',
18+
organizationName: 'sigle',
19+
projectName: 'docs',
20+
21+
presets: [
22+
[
23+
'classic',
24+
/** @type {import('@docusaurus/preset-classic').Options} */
25+
({
26+
docs: {
27+
routeBasePath: '/',
28+
sidebarPath: require.resolve('./sidebars.js'),
29+
editUrl: 'https://github.com/github/sigle/tree/main/',
30+
},
31+
theme: {
32+
customCss: [
33+
require.resolve('./src/css/custom.css'),
34+
require.resolve('@fontsource/open-sans'),
35+
],
36+
},
37+
}),
38+
],
39+
],
40+
41+
themeConfig:
42+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
43+
({
44+
navbar: {
45+
title: 'Sigle Docs',
46+
logo: {
47+
alt: 'Sigle Logo',
48+
src: 'img/logo.png',
49+
},
50+
items: [
51+
{
52+
href: 'https://github.com/pradel/sigle',
53+
label: 'GitHub',
54+
position: 'right',
55+
},
56+
],
57+
},
58+
footer: {
59+
style: 'dark',
60+
links: [
61+
{
62+
title: 'Connect',
63+
items: [
64+
{
65+
label: 'Twitter',
66+
href: 'https://twitter.com/sigleapp',
67+
},
68+
{
69+
label: 'Discord',
70+
href: 'https://discord.gg/td7WmgK22k',
71+
},
72+
{
73+
label: 'Github',
74+
href: 'https://github.com/sigle',
75+
},
76+
],
77+
},
78+
{
79+
title: 'Product',
80+
items: [
81+
{
82+
label: 'Application',
83+
href: 'https://app.sigle.io',
84+
},
85+
{
86+
label: 'Blog',
87+
href: 'https://app.sigle.io/sigleapp.id.blockstack',
88+
},
89+
{
90+
label: 'Feedback',
91+
href: 'https://sigle.canny.io/feature-requests',
92+
},
93+
],
94+
},
95+
{
96+
title: 'More...',
97+
items: [
98+
{
99+
label: 'The Explorer Guild',
100+
href: 'https://www.explorerguild.io/',
101+
},
102+
{
103+
label: 'StxStats',
104+
href: 'https://www.stxstats.co/',
105+
},
106+
],
107+
},
108+
],
109+
copyright: `Copyright © ${new Date().getFullYear()} Sigle`,
110+
},
111+
prism: {
112+
theme: lightCodeTheme,
113+
darkTheme: darkCodeTheme,
114+
},
115+
}),
116+
};
117+
118+
module.exports = config;

0 commit comments

Comments
 (0)