newly designed Icon addition

basic documentation homepage designed
documentation theme configured
This commit is contained in:
Kingkor Roy Tirtho
2022-06-27 17:28:31 +06:00
parent b65b3d28c4
commit 8a4f1f7545
10 changed files with 709 additions and 66 deletions
+30 -20
View File
@@ -6,9 +6,9 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'My Site',
tagline: 'Dinosaurs are cool',
url: 'https://your-docusaurus-test-site.com',
title: 'Fl-Query',
tagline: 'Asynchronous data caching, refetching & invalidation library for Flutter',
url: 'https://flquery.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
@@ -16,8 +16,22 @@ const config = {
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'facebook', // Usually your GitHub org/user name.
projectName: 'docusaurus', // Usually your repo name.
organizationName: 'Kingkor Roy Tirtho', // Usually your GitHub org/user name.
projectName: 'Fl-Query', // Usually your repo name.
plugins: [
async function TailwindCSSPlugin(context, options) {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
// Appends TailwindCSS and AutoPrefixer.
postcssOptions.plugins.push(require("tailwindcss"));
postcssOptions.plugins.push(require("autoprefixer"));
return postcssOptions;
},
};
},
],
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
@@ -37,14 +51,14 @@ const config = {
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
'https://github.com/KRTirtho/fl-query/tree/main/packages/docs/docs/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
'https://github.com/KRTirtho/fl-query/tree/main/packages/docs/blog/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
@@ -57,9 +71,9 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: 'My Site',
title: 'Fl-Query',
logo: {
alt: 'My Site Logo',
alt: 'Fl-Query Logo',
src: 'img/logo.svg',
},
items: [
@@ -67,11 +81,11 @@ const config = {
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Tutorial',
label: 'Documentation',
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/KRTirtho/fl-query',
label: 'GitHub',
position: 'right',
},
@@ -84,7 +98,7 @@ const config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
label: 'Documentation',
to: '/docs/intro',
},
],
@@ -94,15 +108,11 @@ const config = {
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
href: 'https://stackoverflow.com/questions/tagged/fl-query',
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
href: 'https://twitter.com/KrTirtho',
},
],
},
@@ -115,12 +125,12 @@ const config = {
},
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/KRTirtho/fl-query',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Kingkor Roy Tirtho`,
},
prism: {
theme: lightCodeTheme,