Skip to content

Commit

Permalink
Merge pull request #1774 from wix/infra/DocSite_design
Browse files Browse the repository at this point in the history
Docs site design
  • Loading branch information
Inbal-Tish authored Feb 15, 2022
2 parents c2a9509 + 48c43ac commit 4024190
Show file tree
Hide file tree
Showing 31 changed files with 53 additions and 382 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ The package is both **Android** and **iOS** compatible.

See our new [Docs site](https://wix.github.io/react-native-calendars/)


## Try it out

You can run example module by performing these steps:
Expand Down
Binary file removed demo/assets/RNC.png
Binary file not shown.
Binary file added demo/assets/expandable-calendar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo/assets/timeline-calendar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added demo/assets/week-calendar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docsRNC/docs/AgendaList.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
Agenda list component
Agenda list component for the `ExpandableCalendar` component.
[(code example)](https://github.com/wix/react-native-calendars/blob/master/example/src/screens/expandableCalendar.tsx)
:::info
This component extends **[FlatList](https://reactnative.dev/docs/flatlist)** props.
:::
**NOTE: This component should be wrapped with `CalendarProvider` component.**

<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}></div>
<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}><img style={{maxHeight: '420px'}} src={'https://github.com/wix/react-native-calendars/blob/master/demo/assets/expandable-calendar.gif?raw=true'}/>

</div>

## API

Expand Down
5 changes: 4 additions & 1 deletion docsRNC/docs/ExpandableCalendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ Expandable calendar component
:::info
This component extends **[CalendarList](https://github.com/wix/react-native-calendars/blob/master/src/calendar-list/index.tsx)** props.
:::
**NOTE: This component should be wrapped with `CalendarProvider` component.**

<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}></div>
<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}><img style={{maxHeight: '420px'}} src={'https://github.com/wix/react-native-calendars/blob/master/demo/assets/expandable-calendar.gif?raw=true'}/>

</div>

## API

Expand Down
4 changes: 3 additions & 1 deletion docsRNC/docs/Timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Timeline component
This component extends **[ScrollView](https://reactnative.dev/docs/scrollview)** props.
:::

<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}></div>
<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}><img style={{maxHeight: '420px'}} src={'https://github.com/wix/react-native-calendars/blob/master/demo/assets/timeline-calendar.gif?raw=true'}/>

</div>

## API

Expand Down
4 changes: 3 additions & 1 deletion docsRNC/docs/WeekCalendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Week calendar component
This component extends **[CalendarList](https://github.com/wix/react-native-calendars/blob/master/src/calendar-list/index.tsx)** props.
:::

<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}></div>
<div style={{display: 'flex', flexDirection: 'row', overflowX: 'auto', maxHeight: '500px', alignItems: 'center'}}><img style={{maxHeight: '420px'}} src={'https://github.com/wix/react-native-calendars/blob/master/demo/assets/week-calendar.gif?raw=true'}/>

</div>

## API

Expand Down
4 changes: 2 additions & 2 deletions docsRNC/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const config = {
baseUrl: '/react-native-calendars/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/fav-icon.png',
favicon: 'img/logo.png',
organizationName: 'wix', // Usually your GitHub org/user name.
projectName: 'react-native-calendars', // Usually your repo name.
trailingSlash: false,
Expand Down Expand Up @@ -46,7 +46,7 @@ const config = {
title: 'RNC',
logo: {
alt: 'RNC Logo',
src: 'img/RNC.png'
src: 'img/logo.png'
},
items: [
{
Expand Down
28 changes: 9 additions & 19 deletions docsRNC/src/components/HomepageFeatures.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,26 @@ const FeatureList = [
{
title: 'Calendar',
img: require('../../static/img/calendar.png').default,
description: (
<>
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running
quickly.
</>
)
description: <>Calendar component</>
},
{
title: 'Calendar Markings',
img: require('../../static/img/calendar-markings.png').default,
description: (
<>
Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go ahead and move your docs into the{' '}
<code>docs</code> directory.
</>
)
description: <>Marked dates on Calendar's components</>
},
{
title: 'Expandable Calendar',
img: require('../../static/img/expandableCalendar.png').default,
description: (
<>
Extend or customize your website layout by reusing React. Docusaurus can be extended while reusing the same
header and footer.
</>
)
description: <>Expandable calendar component</>
}
// {
// title: 'Timeline Calendar',
// img: require('../../static/img/timeline-calendar.png').default,
// description: (<>Timeline calendar component</>)
// }
];

function Feature({img, title, description}) {
function Feature({img, title /* , description */}) {
return (
<div className={clsx('col col--4')}>
<div className="text--center padding-horiz--md">
Expand Down
14 changes: 7 additions & 7 deletions docsRNC/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #ffae2f;
--ifm-color-primary-dark: #ffa416;
--ifm-color-primary-darker: #fb9900;
--ifm-color-primary-darkest: #e28a00;
--ifm-color-primary-light: #ffb849;
--ifm-color-primary-lighter: #ffc262;
--ifm-color-primary-lightest: #ffcc7c;
--ifm-color-primary: #ffb968;
--ifm-color-primary-dark: #ff9416;
--ifm-color-primary-darker: #ff9416;
--ifm-color-primary-darkest: #ff9416;
--ifm-color-primary-light: #ffdaae;
--ifm-color-primary-lighter: #ffdaae;
--ifm-color-primary-lightest: #ffdaae;
--ifm-code-font-size: 95%;
}

Expand Down
3 changes: 1 addition & 2 deletions docsRNC/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ function HomepageHeader() {
}

export default function Home() {
const {siteConfig} = useDocusaurusContext();
return (
<Layout title={`Hello from ${siteConfig.title}`} description="Description will go into a meta tag in <head />">
<Layout title={`Home`} description="Site main title <head />">
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
3 changes: 2 additions & 1 deletion docsRNC/src/pages/index.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
*/

.heroBanner {
padding: 4rem 0;
padding: 6rem 0;
text-align: center;
position: relative;
overflow: hidden;
height: 180px;
}

@media screen and (max-width: 966px) {
Expand Down
Binary file removed docsRNC/static/img/RNC.png
Binary file not shown.
Binary file removed docsRNC/static/img/docusaurus.png
Binary file not shown.
Binary file removed docsRNC/static/img/fav-icon.png
Binary file not shown.
Binary file added docsRNC/static/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docsRNC/static/img/logo.svg

This file was deleted.

Binary file added docsRNC/static/img/timeline-calendar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4024190

Please sign in to comment.