flint/website
1
0
Fork 0
Code Issues Pull requests Actions Activity

feat: start creating the website
All checks were successful
Deploy Website / build (push) Successful in 1m32s
Details

Browse source
This commit is contained in:
TheClashFruit 2024-04-21 14:51:22 +02:00
parent c7fc4dfecc
commit fb79913b35
Signed by: TheClashFruit
GPG key ID: 09BB24C34C2F3204
18 changed files with 1692 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.forgejo/workflows/deploy.yml
View file

@ -23,6 +23,6 @@ jobs:
pnpm install
pnpm run build
- name: Deploy The Website
uses: Forgejo/pages-deploy@v1.1
uses: Forgejo/pages-deploy@v1.2
with:
folder: ./out

46
components/MarkdownPage.tsx Normal file
View file

@ -0,0 +1,46 @@
import styles from '@/styles/MarkdownPage.module.scss';
import Navbar from './Navbar';
import Head from 'next/head';
type Props = {
metadata?: any;
children: React.ReactNode;
};
export default function MarkdownPage({ metadata, children }: Props) {
return (
<>
<Head>
<title>{`Flint Docs • ${metadata?.title}`}</title>
<link rel="icon" href="/favicon.ico" />
<meta name="description" content={metadata?.description} />
</Head>
<Navbar />
<div className={`${styles.pageContent} ${styles.container}`}>
<aside className={styles.sideBar}>
<nav>
tba
</nav>
</aside>
<main className={styles.markdownContent}>
<h1>{metadata?.title}</h1>
<div>{children}</div>
</main>
</div>
<footer>
<p>
Copyright &copy; { new Date().getFullYear() } Flint &amp; Flint Contributors.
</p>
</footer>
</>
);
}

34
components/Navbar.tsx Normal file
View file

@ -0,0 +1,34 @@
import styles from '@/styles/Navbar.module.scss';
import Link from 'next/link';
import {
Mountain
} from 'lucide-react';
export default function Navbar() {
return (
<nav className={styles.navBar}>
<div className={styles.container}>
<Mountain />
<div className={styles.navCollapse}>
<ul className={styles.navLinks}>
<li>
<Link href="/">Home</Link>
</li>
<li>
<Link href="/docs">Documentation</Link>
</li>
<li>
<Link href="/servers">Servers</Link>
</li>
<li>
<Link href="/blog">Blog</Link>
</li>
</ul>
</div>
</div>
</nav>
);
}

6
docs/index.mdx Normal file
View file

@ -0,0 +1,6 @@
---
title: 'Home'
description: 'Documentation for the project.'
---
This will be the documentation for the project!

7
mdx-components.tsx Normal file
View file

@ -0,0 +1,7 @@
import type { MDXComponents } from 'mdx/types';
export function useMDXComponents(components: MDXComponents): MDXComponents {
return {
...components,
};
}

10
next.config.js
View file

@ -1,12 +1,18 @@
const path = require('path');
const path = require('path');
const createMDX = require('@next/mdx');
/** @type {import('next').NextConfig} */
const nextConfig = {
output: 'export',
reactStrictMode: true,
pageExtensions: [ 'js', 'jsx', 'md', 'mdx', 'ts', 'tsx' ],
sassOptions: {
includePaths: [ path.join(__dirname, 'styles') ]
}
};
module.exports = nextConfig;
module.exports = createMDX({
mdPlugins: [
import('rehype-highlight')
]
})(nextConfig);

10
package.json
View file

@ -9,9 +9,17 @@
"lint": "next lint"
},
"dependencies": {
"@mdx-js/loader": "^3.0.1",
"@mdx-js/react": "^3.0.1",
"@next/mdx": "^14.2.2",
"@types/mdx": "^2.0.13",
"gray-matter": "^4.0.3",
"highlight.js": "^11.9.0",
"lucide-react": "^0.372.0",
"next": "14.2.2",
"react": "^18",
"react-dom": "^18"
"react-dom": "^18",
"rehype-highlight": "^7.0.0"
},
"devDependencies": {
"@types/node": "^20",

59
pages/docs/[[...path]].tsx Normal file
View file

@ -0,0 +1,59 @@
import MarkdownPage from '@/components/MarkdownPage';
import matter from 'gray-matter';
export default function Home({ pageData }: { pageData: any }) {
return (
<MarkdownPage metadata={pageData.metadata}>
{ pageData.content }
</MarkdownPage>
);
}
export async function getStaticProps({ params }: { params: any }) {
const path = require('path');
let pagePath = path.join(process.cwd(), 'docs', (typeof params.path) === 'undefined' ? 'index' : params.path.join('/'));
const pageData = await matter.read(`${pagePath}.mdx`);
return {
props: {
pageData: {
metadata: pageData.data,
content: pageData.content
}
}
};
}
export async function getStaticPaths() {
const fs = require('fs');
const path = require('path');
const docsDir = path.join(process.cwd(), 'docs');
const docsFiles = fs.readdirSync(docsDir);
const paths = docsFiles.map((file: string) => {
if (file.endsWith('.mdx')) {
if (file.startsWith('index')) {
return {
params: {
path: []
}
};
} else {
return {
params: {
path: file.split('.').slice(0, -1)
}
};
}
}
});
return {
paths,
fallback: false
};
}

4
pages/index.tsx
View file

@ -1,6 +1,10 @@
import Navbar from '@/components/Navbar';
export default function Home() {
return (
<>
<Navbar />
<h1>Flint</h1>
<p>

1449
pnpm-lock.yaml
View file

File diff suppressed because it is too large Load diff

BIN
public/favicon.ico
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 124 KiB

1
public/next.svg
View file

@ -1 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>
Side by side

Before

Width:  |  Height:  |  Size: 1.3 KiB

1
public/vercel.svg
View file

@ -1 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 283 64"><path fill="black" d="M141 16c-11 0-19 7-19 18s9 18 20 18c7 0 13-3 16-7l-7-5c-2 3-6 4-9 4-5 0-9-3-10-7h28v-3c0-11-8-18-19-18zm-9 15c1-4 4-7 9-7s8 3 9 7h-18zm117-15c-11 0-19 7-19 18s9 18 20 18c6 0 12-3 16-7l-8-5c-2 3-5 4-8 4-5 0-9-3-11-7h28l1-3c0-11-8-18-19-18zm-10 15c2-4 5-7 10-7s8 3 9 7h-19zm-39 3c0 6 4 10 10 10 4 0 7-2 9-5l8 5c-3 5-9 8-17 8-11 0-19-7-19-18s8-18 19-18c8 0 14 3 17 8l-8 5c-2-3-5-5-9-5-6 0-10 4-10 10zm83-29v46h-9V5h9zM37 0l37 64H0L37 0zm92 5-27 48L74 5h10l18 30 17-30h10zm59 12v10l-3-1c-6 0-10 4-10 10v15h-9V17h9v9c0-5 6-9 13-9z"/></svg>
Side by side

Before

Width:  |  Height:  |  Size: 629 B

20
styles/MarkdownPage.module.scss Normal file
View file

@ -0,0 +1,20 @@
@import 'variables.module';
.pageContent {
display: flex;
> .sideBar {
position: sticky;
top: 0;
height: 100vh;
width: 300px;
margin-right: 20px;
}
> .markdownContent {
flex: 1;
}
}

24
styles/Navbar.module.scss Normal file
View file

@ -0,0 +1,24 @@
@import 'variables.module';
.navBar {
> .container {
display: flex;
justify-content: space-between;
align-items: center;
padding-top: 1rem;
padding-bottom: 1rem;
> .navCollapse {
> .navLinks {
list-style: none;
display: flex;
gap: 0.5rem;
}
}
}
}

10
styles/globals.scss
View file

@ -1,6 +1,16 @@
@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+Mono:wght@100..900&family=Noto+Sans:ital,wght@0,100..900;1,100..900&family=Noto+Serif:ital,wght@0,100..900;1,100..900&display=swap');
* {
padding: 0;
margin: 0;
box-sizing: border-box;
}
body {
font-family: 'Noto Sans', sans;
}
pre, code {
font-family: 'Noto Sans Mono', monospace;
}

13
styles/variables.module.scss Normal file
View file

@ -0,0 +1,13 @@
.container {
max-width: 1200px;
margin: 0 auto;
@media (max-width: 1200px) {
padding: 0 1rem;
}
@media (max-width: 768px) {
padding: 0 1rem;
}
}

28
tsconfig.json
View file

@ -1,6 +1,10 @@
{
"compilerOptions": {
"lib": ["dom", "dom.iterable", "esnext"],
"lib": [
"dom",
"dom.iterable",
"esnext"
],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
@ -13,9 +17,23 @@
"jsx": "preserve",
"incremental": true,
"paths": {
"@/*": ["./*"]
}
"@/*": [
"./*"
]
},
"plugins": [
{
"name": "next"
}
]
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
"exclude": ["node_modules"]
"include": [
"next-env.d.ts",
"**/*.ts",
"**/*.tsx",
".next/types/**/*.ts"
],
"exclude": [
"node_modules"
]
}