Skip to content

Commit 93f3543

Browse files
authored
docs: add logo to overview (#2944)
1 parent 8bbc97e commit 93f3543

File tree

4 files changed

+28
-5
lines changed

4 files changed

+28
-5
lines changed

docs/overview.mdx

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,23 @@
22
id: overview
33
title: FlutterFire Overview
44
sidebar_label: Overview
5+
hide_title: true
56
---
67

7-
Welcome to FlutterFire! 🔥
8+
<img
9+
data-asset="false"
10+
src="/img/flutterfire.svg"
11+
alt="FlutterFire Logo"
12+
style={{
13+
height: 100,
14+
display: "block",
15+
margin: "0 auto",
16+
}}
17+
/>
18+
19+
<h1 style={{ textAlign: 'center', marginBottom: '4rem' }}>FlutterFire Overview</h1>
20+
21+
Welcome to FlutterFire! 🔥
822

923
FlutterFire is a set of Flutter plugins which connect your Flutter application to [Firebase](https://firebase.com).
1024

@@ -174,7 +188,7 @@ Once initialized, you're ready to get started using FlutterFire!
174188

175189
## Overriding Native SDK Versions
176190

177-
FlutterFire internally sets the versions of the native SDKs that each module uses. Each release is tested against a fixed
191+
FlutterFire internally sets the versions of the native SDKs that each module uses. Each release is tested against a fixed
178192
set of SDK version to ensure everything works as expected.
179193

180194
If you wish to change these versions, you can manually override the native SDK versions
@@ -200,7 +214,6 @@ Open your `/ios/Podfile` and add any of the globals below to the top of the file
200214
$FirebaseSDKVersion = '21.1.0'
201215
```
202216

203-
204217
## Next Steps
205218

206219
On its own the [`firebase_core`](!firebase_core) plugin provides basic functionality for usage with Firebase. FlutterFire is broken down

website/docusaurus.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ module.exports = {
3636
},
3737
navbar: {
3838
title: 'FlutterFire',
39+
logo: {
40+
alt: 'FlutterFire Logo',
41+
src: '/img/flutterfire_300x.png',
42+
},
3943
links: [
4044
{
4145
to: 'docs/overview',

website/src/pages/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ function Home() {
7070
<h1>{siteConfig.title}</h1>
7171
<h2>{siteConfig.tagline}</h2>
7272
<div className={styles.actions}>
73-
<Link to={`${siteConfig.baseUrl}docs`}>Get Started &raquo;</Link>
73+
<Link to={`${siteConfig.baseUrl}docs/overview`}>Get Started &raquo;</Link>
7474
<Link to="https://github.com/firebaseextended/flutterfire">GitHub &raquo;</Link>
7575
</div>
7676
</div>

website/src/theme/MDXComponents/index.tsx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import React, { HTMLProps } from 'react';
22
import Link from '@docusaurus/Link';
33
import CodeBlock from '@theme/CodeBlock';
4-
import Heading from '@theme/Heading';
54
import Tabs from '@theme/Tabs';
5+
import Heading from '@theme/Heading';
66
import TabItem from '@theme/TabItem';
77
import IdealImage from '@theme/IdealImage';
88
import Zoom from 'react-medium-image-zoom';
@@ -41,6 +41,12 @@ export default {
4141
},
4242

4343
img: (props: HTMLProps<HTMLImageElement>) => {
44+
// @ts-ignore
45+
if (props['data-asset'] === 'false') {
46+
// @ts-ignore
47+
return <img {...props} />;
48+
}
49+
4450
let alt = props.alt || '';
4551

4652
// Prefix any alt tags with "hide:" to not show them as a caption

0 commit comments

Comments
 (0)