Skip to content

Commit 57fc123

Browse files
committed
Add SVG illustration and TypeScript configuration file
- Added a new SVG file for the illustration "Focus on What Matters" to the static images directory. - Created a TypeScript configuration file (tsconfig.json) extending the Docusaurus base configuration for improved editor experience.
1 parent a53b30e commit 57fc123

27 files changed

Lines changed: 17479 additions & 4 deletions

.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*
File renamed without changes.
File renamed without changes.
File renamed without changes.

index.md renamed to docs/intro.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Fire Framework
1+
---
2+
sidebar_position: 1
3+
---
24

3-
<div align="center">
4-
<img src="./public/fire.svg" alt="Fire Framework Logo" width="200">
5-
</div>
5+
# Fire Framework
66

77
Welcome to the official documentation of the **Fire Project**! 🚀
88
This guide is your go-to resource for understanding, installing, and mastering the **Fire Framework** and its Starter Kit.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docusaurus.config.ts

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
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: "Fire Project Starter Kit 🚀 ",
9+
tagline: "Build PHP applications efficiently",
10+
favicon: "img/favicon.ico",
11+
12+
// Set the production url of your site here
13+
url: "https://your-docusaurus-site.example.com",
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: "BottyIvan", // Usually your GitHub org/user name.
21+
projectName: "fire-docs", // Usually your repo name.
22+
23+
onBrokenLinks: "throw",
24+
onBrokenMarkdownLinks: "warn",
25+
26+
// Even if you don't use internationalization, you can use this field to set
27+
// useful metadata like html lang. For example, if your site is Chinese, you
28+
// may want to replace "en" with "zh-Hans".
29+
i18n: {
30+
defaultLocale: "en",
31+
locales: ["en"],
32+
},
33+
34+
presets: [
35+
[
36+
"classic",
37+
{
38+
docs: {
39+
sidebarPath: "./sidebars.ts",
40+
// Please change this to your repo.
41+
// Remove this to remove the "edit this page" links.
42+
// editUrl:
43+
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
44+
},
45+
blog: {
46+
showReadingTime: true,
47+
feedOptions: {
48+
type: ["rss", "atom"],
49+
xslt: true,
50+
},
51+
// Please change this to your repo.
52+
// Remove this to remove the "edit this page" links.
53+
// editUrl:
54+
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
55+
// Useful options to enforce blogging best practices
56+
onInlineTags: "warn",
57+
onInlineAuthors: "warn",
58+
onUntruncatedBlogPosts: "warn",
59+
},
60+
theme: {
61+
customCss: "./src/css/custom.css",
62+
},
63+
} satisfies Preset.Options,
64+
],
65+
],
66+
67+
themeConfig: {
68+
// Replace with your project's social card
69+
image: "img/docusaurus-social-card.jpg",
70+
navbar: {
71+
title: "Fire Project",
72+
logo: {
73+
alt: "Fire Project Starter Kit Logo",
74+
src: "img/logo.svg",
75+
},
76+
items: [
77+
{
78+
type: "docSidebar",
79+
sidebarId: "tutorialSidebar",
80+
position: "left",
81+
label: "Tutorial",
82+
},
83+
// { to: "/blog", label: "Blog", position: "left" },
84+
{
85+
href: "https://github.com/BottyIvan/fire-framework",
86+
label: "fire-framework",
87+
position: "right",
88+
},
89+
{
90+
href: "https://github.com/BottyIvan/fire-starter-kit",
91+
label: "fire-starter-kit",
92+
position: "right",
93+
},
94+
],
95+
},
96+
footer: {
97+
style: "dark",
98+
links: [
99+
{
100+
title: "Docs",
101+
items: [
102+
{
103+
label: "Tutorial",
104+
to: "/docs/intro",
105+
},
106+
],
107+
},
108+
{
109+
title: "Community",
110+
items: [
111+
// {
112+
// label: "Stack Overflow",
113+
// href: "https://stackoverflow.com/questions/tagged/docusaurus",
114+
// },
115+
// {
116+
// label: "Discord",
117+
// href: "https://discordapp.com/invite/docusaurus",
118+
// },
119+
{
120+
label: "X",
121+
href: "https://x.com/bottyivan",
122+
},
123+
],
124+
},
125+
{
126+
title: "More",
127+
items: [
128+
// {
129+
// label: "Blog",
130+
// to: "/blog",
131+
// },
132+
{
133+
label: "GitHub",
134+
href: "https://github.com/BottyIvan",
135+
},
136+
],
137+
},
138+
],
139+
copyright: `Copyright © ${new Date().getFullYear()} ivanbotty.cloud. Built with Docusaurus.`,
140+
},
141+
prism: {
142+
theme: prismThemes.github,
143+
darkTheme: prismThemes.dracula,
144+
},
145+
} satisfies Preset.ThemeConfig,
146+
};
147+
148+
export default config;

0 commit comments

Comments
 (0)