Skip to content

Commit d73e5f4

Browse files
authored
Merge pull request #144 from NLipatov/feature/18
docs update
2 parents 191fbb6 + 5c6a049 commit d73e5f4

File tree

8 files changed

+858
-1331
lines changed

8 files changed

+858
-1331
lines changed

docs/TunGo/package-lock.json

Lines changed: 792 additions & 1275 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/TunGo/package.json

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,17 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "3.7.0",
18-
"@docusaurus/preset-classic": "3.7.0",
17+
"@docusaurus/core": "3.8.1",
18+
"@docusaurus/preset-classic": "3.8.1",
1919
"@mdx-js/react": "^3.1.0",
20-
"asciinema-player": "^3.9.0",
2120
"clsx": "^2.1.1",
2221
"prism-react-renderer": "^2.4.1",
2322
"react": "^19.1.0",
2423
"react-dom": "^19.1.0"
2524
},
2625
"devDependencies": {
27-
"@docusaurus/module-type-aliases": "3.7.0",
28-
"@docusaurus/types": "3.7.0"
26+
"@docusaurus/module-type-aliases": "3.8.1",
27+
"@docusaurus/types": "3.8.1"
2928
},
3029
"browserslist": {
3130
"production": [

docs/TunGo/src/components/asciinema/player.js

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/TunGo/src/components/features/index.js

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import clsx from 'clsx';
1+
import Clsx from 'clsx';
22
import Heading from '@theme/Heading';
3-
import styles from './styles.module.css';
3+
import Styles from './styles.module.css';
44

55
const FeatureList = [
66
{
@@ -41,27 +41,40 @@ const FeatureList = [
4141
</>
4242
),
4343
},
44+
{
45+
title: 'Supported Platforms',
46+
Svg: require('@site/static/svg/monitor.svg').default,
47+
description: (
48+
<div className={Styles.featureDescriptionList}>
49+
<ul>
50+
<li><strong>Linux</strong> (client and server mode)</li>
51+
<li><strong>macOS</strong> (client mode)</li>
52+
<li><strong>Windows</strong> (client mode)</li>
53+
</ul>
54+
</div>
55+
),
56+
},
4457
];
4558

4659
function Feature({Svg, title, description}) {
4760
return (
48-
<div className={clsx('col col--3')}>
61+
<div className={Clsx('col col--3')}>
4962
<div className="text--center">
50-
<Svg className={styles.featureSvg} role="img" />
63+
<Svg className={Styles.featureSvg} role="img"/>
5164
</div>
5265
<div className="text--center padding-horiz--md">
53-
<Heading as="h3">{title}</Heading>
66+
<Heading as="h3">{title}</Heading>
5467
<div>{description}</div>
5568
</div>
5669
</div>
5770
);
5871
}
5972

60-
export default function HomepageFeatures() {
73+
export default function Features() {
6174
return (
62-
<section className={styles.features}>
75+
<section className={Styles.features}>
6376
<div className="container">
64-
<div className="row">
77+
<div className="row" style={{justifyContent: "center"}}>
6578
{FeatureList.map((props, idx) => (
6679
<Feature key={idx} {...props} />
6780
))}
Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
.features {
2-
display: flex;
3-
align-items: center;
2+
display: grid;
43
padding: 2rem 0;
5-
width: 100%;
4+
justify-items: center;
65
}
76

87
.featureSvg {
9-
height: 200px;
10-
width: 200px;
8+
height: 12rem;
9+
width: 12rem;
1110
}
11+
12+
.featureDescriptionList {
13+
display: flex;
14+
flex-direction: column;
15+
text-align: left;
16+
}
17+
18+
.jcCenter {
19+
justify-content: center;
20+
}

docs/TunGo/src/components/footer/footer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import React from 'react';
22
import Link from '@docusaurus/Link';
3-
import styles from './footer.module.css';
3+
import Styles from './footer.module.css';
44

55
export default function Footer() {
66
return (
7-
<footer className={styles.footer}>
7+
<footer className={Styles.footer}>
88
<p>
99
Icons by{' '}
1010
<Link to="https://openmoji.org/" target="_blank" rel="noopener noreferrer">

docs/TunGo/src/pages/index.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
import clsx from 'clsx';
1+
import Clsx from 'clsx';
22
import Link from '@docusaurus/Link';
3-
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
3+
import UseDocusaurusContext from '@docusaurus/useDocusaurusContext';
44
import Layout from '@theme/Layout';
5-
import HomepageFeatures from '@site/src/components/features';
5+
import Features from '@site/src/components/features';
66
import Heading from '@theme/Heading';
7-
import styles from './index.module.css';
7+
import Styles from './index.module.css';
88
import Footer from "../components/footer/footer";
99

1010
function HomepageHeader() {
11-
const {siteConfig} = useDocusaurusContext();
11+
const {siteConfig} = UseDocusaurusContext();
1212
return (
13-
<header className={clsx('hero hero--primary', styles.heroBanner)}>
13+
<header className={Clsx('hero hero--primary', Styles.heroBanner)}>
1414
<div className="container">
1515
<Heading as="h1" className="hero__title" style={{color: "white"}}>
1616
{siteConfig.title}
1717
</Heading>
1818
<p className="hero__subtitle" style={{color: "white"}}>{siteConfig.tagline}</p>
19-
<div className={styles.buttons}>
19+
<div className={Styles.buttons}>
2020
<Link
2121
className="button button--secondary button--lg"
2222
to="/docs/QuickStart">
23-
Set up your TunGo VPN tunnel in minutes ⏱️
23+
Get started in minutes ⏱️
2424
</Link>
2525
</div>
2626
</div>
@@ -30,14 +30,14 @@ function HomepageHeader() {
3030

3131
// noinspection JSUnusedGlobalSymbols
3232
export default function Home() {
33-
const {siteConfig} = useDocusaurusContext();
33+
const {siteConfig} = UseDocusaurusContext();
3434
return (
3535
<Layout
3636
title={`${siteConfig.title} — Minimalistic, Fast & Secure Open Source VPN`}
3737
description={`Secure your connection with ${siteConfig.title}: lightweight, fast, open-source VPN built in Go using modern cryptography.`}>
3838
<HomepageHeader />
3939
<main>
40-
<HomepageFeatures />
40+
<Features />
4141
</main>
4242
<Footer/>
4343
</Layout>

docs/TunGo/static/svg/monitor.svg

Lines changed: 15 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)