Skip to content

Commit

Permalink
Web design updates
Browse files Browse the repository at this point in the history
  • Loading branch information
fgatti675 committed Nov 22, 2023
1 parent 1ae6a4c commit c2314ab
Show file tree
Hide file tree
Showing 51 changed files with 317 additions and 346 deletions.
2 changes: 1 addition & 1 deletion website/docs/collections/multiple_filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Multiple filters in collection views
sidebar_label: Multiple filters
---

Unfortunately Firestore is limited to a single `where` clause per query by default.
Firestore is a bit limited when filtering and sorting. limited to a single `where` clause per query by default.
This means that filtering by multiple fields is not possible out of the box.

Anyhow, you can define indexes in Firestore to allow queries per multiple fields.
Expand Down
20 changes: 18 additions & 2 deletions website/docs/migrating_from_v2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,20 @@ By doing this you will **not need to specify your Firebase project credentials**
since the service will be able to access your project directly. You will only need
to specify the **project id**.

## Initialize a FireCMS 3 project in a new folder

It is advisable to create a new project from scratch and then migrate your collections and views to
the new folder.

In order to do so, run
```
yarn create firecms-app
```
and create a new project in a new folder.

The CLI will initialize an empty project with the new format, and all the configuration files
ready so you don't need to worry about it.


## Migrating collections to the new format

Expand All @@ -36,17 +50,19 @@ code like until now.
Also, you can have collections defined in both places, and decide if the code defined collections
can be modified by the user or not.

Please note that properties defined in code will not be editable by the user, unless you
explicitly mark them as `editable: true`.

## Changing the import

The package has been renamed to `@firecms/firebase` instead of `firecms`. You need to update your
imports to use the new package name.



## New format

Since it is now possible to deploy FireCMS in our hosted service, the output
of your project needs to be a in a specific format.
of your project needs to be in a specific format.

The `index.ts` file should export a `FireCMSAppConfig` object, which is defined as follows:

Expand Down
19 changes: 12 additions & 7 deletions website/docs/navigation/app_config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,17 @@ id: app_config
title: App Config
---

When creating a FireCMS app, you will **either** be using the components:
- `FirebaseCMSApp` Default implementation of FireCMS that uses Firebase Auth, Firestore
and Firebase Storage.
- `FireCMSApp` Lower level component that allows you to provide your own implementations
of the different services and more customization.
The app config is the main configuration object of FireCMS. It is defined
by the interface `FireCMSAppConfig`. In order to customize the CMS, you need
to create a project in [app.firecms.co](https://app.firecms.co) and
initialise a new project in code with `yarn create firecms-app`.

After those steps are ready you can use the `FireCMSAppConfig` export to add
your own customizations, like custom reusable properties or fields, collections,
entity views, cms views, etc.




### Navigation

Expand All @@ -30,8 +36,7 @@ collections that get mapped to CMS views, or create your own top level React vie

### Customization

Let's see all the customization options available for `FirebaseCMSApp` (most
of them are also available for `FireCMSApp`).
Let's see all the customization options available:

* `name`: Name of the app, displayed as the main title and in the tab title

Expand Down
128 changes: 0 additions & 128 deletions website/docs/openai.md

This file was deleted.

4 changes: 2 additions & 2 deletions website/docs/what_is_new_v3.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: what_is_new_v3
title: What's new in FireCMS 3.0
sidebar_label: What's new in FireCMS 3.0
title: What's new in FireCMS 3.0
sidebar_label: What's new in FireCMS 3.0
---

The new version of FireCMS is a major release that brings a lot of new features
Expand Down
9 changes: 7 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,9 @@ module.exports = {
}
],
colorMode: {
// defaultMode: "system",
respectPrefersColorScheme: true,
defaultMode: "dark",
disableSwitch: true,
// respectPrefersColorScheme: false,
},
navbar: {
title: "FireCMS",
Expand All @@ -104,6 +105,10 @@ module.exports = {
label: "Features",
to: "/features",
},
{
label: "OpenAI GPT integration",
to: "/openai",
},
{
label: "Advanced content editing",
to: "/f/advanced_forms",
Expand Down
13 changes: 2 additions & 11 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,10 @@ module.exports = {
"label": "Introduction",
"id": "intro"
},
{
"type": "doc",
"label": "Introduction",
"id": "what_is_new_v3"
},
{
"type": "doc",
"label": "Migrating from v2",
"id": "migrating_from_v2"
},
"what_is_new_v3",
"migrating_from_v2",
"quickstart",
"firebase_setup",
"openai",
{
"type":"category",
"label":"Collections",
Expand Down
98 changes: 97 additions & 1 deletion website/src/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,53 @@
/* cyrillic-ext */
@font-face {
font-family: 'IBM Plex Mono';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url(https://fonts.gstatic.com/s/ibmplexmono/v19/-F63fjptAgt5VM-kVkqdyU8n1iIq131nj-otFQ.woff2) format('woff2');
unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
}

/* cyrillic */
@font-face {
font-family: 'IBM Plex Mono';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url(https://fonts.gstatic.com/s/ibmplexmono/v19/-F63fjptAgt5VM-kVkqdyU8n1isq131nj-otFQ.woff2) format('woff2');
unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
}

/* vietnamese */
@font-face {
font-family: 'IBM Plex Mono';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url(https://fonts.gstatic.com/s/ibmplexmono/v19/-F63fjptAgt5VM-kVkqdyU8n1iAq131nj-otFQ.woff2) format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
}

/* latin-ext */
@font-face {
font-family: 'IBM Plex Mono';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url(https://fonts.gstatic.com/s/ibmplexmono/v19/-F63fjptAgt5VM-kVkqdyU8n1iEq131nj-otFQ.woff2) format('woff2');
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}

/* latin */
@font-face {
font-family: 'IBM Plex Mono';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url(https://fonts.gstatic.com/s/ibmplexmono/v19/-F63fjptAgt5VM-kVkqdyU8n1i8q131nj-o.woff2) format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}

/* stylelint-disable docusaurus/copyright-header */
/* cyrillic-ext */
@font-face {
Expand Down Expand Up @@ -132,20 +182,66 @@

html[data-theme='dark'] {
--ifm-custom-navbar-background-color: rgba(48, 49, 55, 0.33);
--ifm-background-color: rgb(5, 6, 11);
--ifm-background-color: #242628;
--ifm-background-surface-color: #232328;
--ifm-color-emphasis-100: #232328;
/*--ifm-background-surface-color: #242526;*/
}

article header {
margin-top: 40px;
margin-bottom: 16px;
}

article h2 {
margin-top: 40px;
margin-bottom: 16px;
}

article blockquote {
margin-top: 16px;
margin-bottom: 16px;
}

.sidebarViewport_node_modules-\@docusaurus-theme-classic-lib-theme-DocPage-Layout-Sidebar-styles-module {
background-color: var(--ifm-background-color);
border: none;
}

@media (min-width: calc(84rem + 600px)) {
.docSidebarContainer_node_modules-\@docusaurus-theme-classic-lib-theme-DocPage-Layout-Sidebar-styles-module {
width: calc((100vw - 84rem) / 2) !important;
}

.sidebarViewport_node_modules-\@docusaurus-theme-classic-lib-theme-DocPage-Layout-Sidebar-styles-module {
width: calc((100vw - 84rem) / 2);
display: flex;
flex-direction: column;
align-items: end;
}
main .container {
margin-left: 0 !important;
}
}

.navbar.navbar--fixed-top {
padding: 0;
background-color: var(--ifm-custom-navbar-background-color);
}

.navbar__logo{
width: 32px;
}


.navbar.navbar--fixed-top:not(.navbar-sidebar--show) {
backdrop-filter: blur(8px);
}

.navbar__link {
font-weight: var(--ifm-font-weight-bold);
}

[role='banner'] {
z-index: 5;
}
Expand Down
5 changes: 5 additions & 0 deletions website/src/css/tailwind.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,8 @@
@tailwind base;
@tailwind components;
@tailwind utilities;


.navbar__items--left .navbar__item {
@apply font-mono font-bold uppercase;
}
Loading

0 comments on commit c2314ab

Please sign in to comment.