docs: prefers-color-scheme based color scheme

This commit is contained in:
Kingkor Roy Tirtho
2023-10-19 10:35:42 +06:00
parent 124ef7d0f6
commit 1aa7d356e8
2 changed files with 50 additions and 54 deletions
+3 -10
View File
@@ -4,7 +4,7 @@ title: Overview
id: overview id: overview
--- ---
Asynchronous data caching, refetching & invalidation library for Flutter. FL-Query lets you manage & distribute your async data without touching any global state Asynchronous data caching, refetching & invalidation library for Flutter. Fl-Query lets you manage & distribute your async data without touching any global state
Fl-Query makes asynchronous server state management a breeze in flutter Fl-Query makes asynchronous server state management a breeze in flutter
@@ -33,10 +33,6 @@ For elite flutter_hooks user (Welcome to the flutter cool community btw😎)
$ flutter pub add flutter_hooks fl_query_hooks $ flutter pub add flutter_hooks fl_query_hooks
``` ```
## Docs
You can find the documentation of fl-query at https://fl-query.krtirtho.dev/
## Basic Usage ## Basic Usage
Initialize the cache databases in your `main` method Initialize the cache databases in your `main` method
@@ -158,15 +154,12 @@ class MyApp extends HookWidget{
} }
``` ```
*To master the fl-query follow the official blog at https://fl-query.krtirtho.dev/blog*
## Why? ## Why?
<p align="center"> <p align="center">
<img src="https://media.giphy.com/media/1M9fmo1WAFVK0/giphy.gif" alt="The hell, why?"/> <img src="https://media.giphy.com/media/1M9fmo1WAFVK0/giphy.gif" alt="The hell, why?"/>
</p> </p>
The main purpose of Fl-Query is providing the easiest way to manage the messy server-state part requiring the least amount of code with code reusability & performance The main purpose of Fl-Query is providing the easiest way to manage the messy server-state part requiring the least amount of code with code reusability & performance. This let's you focus more on those cool UI animations & transitions✨. Leave the boring stuff to Fl-Query
This let's you focus more on those cool UI animations & transitions✨. Leave the boring stuff to fl-query
**Q. Isn't `FutureBuilder` good?** **Q. Isn't `FutureBuilder` good?**
@@ -174,4 +167,4 @@ This let's you focus more on those cool UI animations & transitions✨. Leave th
**Q. So `FutureProvider` from riverpod or provider not enough?** **Q. So `FutureProvider` from riverpod or provider not enough?**
Probably yes. Although riverpod@v2 has added a lot of caching related features but still optimistic updates, periodic refetching & disk persistence are missing. Let's not forget about infinite pagination, it's a nightmare😅. In case of provider, same story. It's a great package but it's not ideal for server-state management Probably yes. Although riverpod@v2 has added a lot of caching related features but still optimistic updates, periodic refetching & disk persistence are missing. Let's not forget about infinite pagination, it's a nightmare😅. In case of provider, same story. It's a great package but it's not the easiest one for server-state management
+47 -44
View File
@@ -1,22 +1,22 @@
// @ts-check // @ts-check
// Note: type annotations allow type checking and IDEs autocompletion // Note: type annotations allow type checking and IDEs autocompletion
const { themes } = require('prism-react-renderer'); const { themes } = require("prism-react-renderer");
/** @type {import('@docusaurus/types').Config} */ /** @type {import('@docusaurus/types').Config} */
const config = { const config = {
title: 'Fl-Query', title: "Fl-Query",
tagline: 'Async data manager for Flutter', tagline: "Async data manager for Flutter",
url: 'https://flquery.com', url: "https://flquery.com",
baseUrl: '/', baseUrl: "/",
onBrokenLinks: 'throw', onBrokenLinks: "throw",
onBrokenMarkdownLinks: 'warn', onBrokenMarkdownLinks: "warn",
favicon: 'img/favicon.ico', favicon: "img/favicon.ico",
// GitHub pages deployment config. // GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these. // If you aren't using GitHub pages, you don't need these.
organizationName: 'Kingkor Roy Tirtho', // Usually your GitHub org/user name. organizationName: "Kingkor Roy Tirtho", // Usually your GitHub org/user name.
projectName: 'Fl-Query', // Usually your repo name. projectName: "Fl-Query", // Usually your repo name.
plugins: [ plugins: [
async function TailwindCSSPlugin(context, options) { async function TailwindCSSPlugin(context, options) {
@@ -36,31 +36,31 @@ const config = {
// metadata like html lang. For example, if your site is Chinese, you may want // metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans". // to replace "en" with "zh-Hans".
i18n: { i18n: {
defaultLocale: 'en', defaultLocale: "en",
locales: ['en'], locales: ["en"],
}, },
presets: [ presets: [
[ [
'classic', "classic",
/** @type {import('@docusaurus/preset-classic').Options} */ /** @type {import('@docusaurus/preset-classic').Options} */
({ ({
docs: { docs: {
sidebarPath: require.resolve('./sidebars.js'), sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo. // Please change this to your repo.
// Remove this to remove the "edit this page" links. // Remove this to remove the "edit this page" links.
editUrl: editUrl:
'https://github.com/KRTirtho/fl-query/tree/main/packages/docs/docs/', "https://github.com/KRTirtho/fl-query/tree/main/packages/docs/docs/",
}, },
blog: { blog: {
showReadingTime: true, showReadingTime: true,
// Please change this to your repo. // Please change this to your repo.
// Remove this to remove the "edit this page" links. // Remove this to remove the "edit this page" links.
editUrl: editUrl:
'https://github.com/KRTirtho/fl-query/tree/main/packages/docs/blog/', "https://github.com/KRTirtho/fl-query/tree/main/packages/docs/blog/",
}, },
theme: { theme: {
customCss: require.resolve('./src/css/custom.css'), customCss: require.resolve("./src/css/custom.css"),
}, },
}), }),
], ],
@@ -69,62 +69,65 @@ const config = {
themeConfig: themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */ /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({ ({
colorMode: {
respectPrefersColorScheme: true,
},
navbar: { navbar: {
title: 'Fl-Query', title: "Fl-Query",
logo: { logo: {
alt: 'Fl-Query Logo', alt: "Fl-Query Logo",
src: 'img/logo.svg', src: "img/logo.svg",
}, },
items: [ items: [
{ {
type: 'doc', type: "doc",
docId: 'getting-started/overview', docId: "getting-started/overview",
position: 'left', position: "left",
label: 'Documentation', label: "Documentation",
}, },
{to: '/blog', label: 'Blog', position: 'left'}, { to: "/blog", label: "Blog", position: "left" },
{ {
href: 'https://github.com/KRTirtho/fl-query', href: "https://github.com/KRTirtho/fl-query",
label: 'GitHub', label: "GitHub",
position: 'right', position: "right",
}, },
], ],
}, },
footer: { footer: {
style: 'dark', style: "dark",
links: [ links: [
{ {
title: 'Docs', title: "Docs",
items: [ items: [
{ {
label: 'Documentation', label: "Documentation",
to: '/docs/getting-started/overview', to: "/docs/getting-started/overview",
}, },
], ],
}, },
{ {
title: 'Community', title: "Community",
items: [ items: [
{ {
label: 'Stack Overflow', label: "Stack Overflow",
href: 'https://stackoverflow.com/questions/tagged/fl-query', href: "https://stackoverflow.com/questions/tagged/fl-query",
}, },
{ {
label: 'Twitter', label: "Twitter",
href: 'https://twitter.com/KrTirtho', href: "https://twitter.com/KrTirtho",
}, },
], ],
}, },
{ {
title: 'More', title: "More",
items: [ items: [
{ {
label: 'Blog', label: "Blog",
to: '/blog', to: "/blog",
}, },
{ {
label: 'GitHub', label: "GitHub",
href: 'https://github.com/KRTirtho/fl-query', href: "https://github.com/KRTirtho/fl-query",
}, },
], ],
}, },
@@ -134,7 +137,7 @@ const config = {
prism: { prism: {
theme: themes.oneLight, theme: themes.oneLight,
darkTheme: themes.oneDark, darkTheme: themes.oneDark,
additionalLanguages: ["dart"] additionalLanguages: ["dart"],
}, },
}), }),
}; };