Skip to content

Commit fab6dde

Browse files
Konoyoru435Konoyoru435
committed
feat: init
0 parents  commit fab6dde

25 files changed

Lines changed: 27817 additions & 0 deletions

‎.github/workflows/deploy.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
jobs:
11+
build:
12+
name: Build Docusaurus
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 18
21+
cache: yarn
22+
23+
- name: Install dependencies
24+
run: yarn install --frozen-lockfile
25+
- name: Build website
26+
run: yarn build
27+
28+
- name: Upload Build Artifact
29+
uses: actions/upload-pages-artifact@v3
30+
with:
31+
path: build
32+
33+
deploy:
34+
name: Deploy to GitHub Pages
35+
needs: build
36+
37+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
38+
permissions:
39+
pages: write # to deploy to Pages
40+
id-token: write # to verify the deployment originates from an appropriate source
41+
42+
# Deploy to the github-pages environment
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

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

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

‎blog/2025-05-24-hello.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
slug: 2025-05-24-hello
3+
title: Hello
4+
authors: [Yazawazi]
5+
tags: [features]
6+
---
7+
8+
This is the Funix Wiki & Blog site, where future Funix documentation, releases, and updates will gradually be moved.

‎blog/authors.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Yazawazi:
2+
name: Yazawazi
3+
title: Funix Maintainer
4+
url: https://yazawazi.moe
5+
image_url: https://github.com/Yazawazi.png
6+
socials:
7+
x: HMKAPJNHDMO
8+
github: Yazawazi

‎blog/tags.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
features:
2+
label: Features
3+
permalink: /features
4+
description: Something new features
5+
6+
fixes:
7+
label: Fixes
8+
permalink: /fixes
9+
description: Something new fixes

‎docs/intro.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Get Started
6+
7+
WIP

‎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: 'Funix Site',
9+
tagline: 'Building web apps without manually creating widgets',
10+
favicon: 'img/f-logo.png',
11+
12+
// Set the production url of your site here
13+
url: 'https://funix.io',
14+
// Set the /<baseUrl>/ pathname under which your site is served
15+
// For GitHub pages deployment, it is often '/<projectName>/'
16+
baseUrl: '/',
17+
18+
// GitHub pages deployment config.
19+
// If you aren't using GitHub pages, you don't need these.
20+
organizationName: 'TexteaInc', // Usually your GitHub org/user name.
21+
projectName: 'funix-web', // Usually your repo name.
22+
23+
onBrokenLinks: 'throw',
24+
onBrokenMarkdownLinks: 'warn',
25+
26+
deploymentBranch: "gh-pages",
27+
trailingSlash: false,
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+
{
41+
docs: {
42+
sidebarPath: './sidebars.ts',
43+
},
44+
blog: {
45+
showReadingTime: true,
46+
feedOptions: {
47+
type: ['rss', 'atom'],
48+
xslt: true,
49+
},
50+
// Useful options to enforce blogging best practices
51+
onInlineTags: 'warn',
52+
onInlineAuthors: 'warn',
53+
onUntruncatedBlogPosts: 'warn',
54+
},
55+
theme: {
56+
customCss: './src/css/custom.css',
57+
},
58+
} satisfies Preset.Options,
59+
],
60+
],
61+
62+
themeConfig: {
63+
// Replace with your project's social card
64+
image: 'img/funix_header.png',
65+
navbar: {
66+
title: 'Funix Site',
67+
logo: {
68+
alt: 'Funix Logo',
69+
src: 'img/f-logo.svg',
70+
},
71+
items: [
72+
{
73+
type: 'docSidebar',
74+
sidebarId: 'tutorialSidebar',
75+
position: 'left',
76+
label: 'Tutorial',
77+
},
78+
{to: '/blog', label: 'Blog', position: 'left'},
79+
{
80+
href: 'https://github.com/TexteaInc/funix',
81+
label: 'GitHub',
82+
position: 'right',
83+
},
84+
],
85+
},
86+
footer: {
87+
style: 'dark',
88+
links: [
89+
{
90+
title: 'Docs',
91+
items: [
92+
{
93+
label: 'Tutorial',
94+
to: '/docs/intro',
95+
},
96+
],
97+
},
98+
{
99+
title: 'Community',
100+
items: [
101+
{
102+
label: 'Discord',
103+
href: 'https://discord.gg/sxHQE3mvuZ',
104+
},
105+
{
106+
label: 'X',
107+
href: 'https://x.com/TexteaInc',
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/TexteaInc/funix',
121+
},
122+
],
123+
},
124+
],
125+
copyright: `Copyright © ${new Date().getFullYear()} Textea, 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;

0 commit comments

Comments
 (0)