Skip to content

Commit 6d37c44

Browse files
JeremyDolleJeremyDolle
committed
refactor(doc): update doc dependencies
1 parent 54cd1a6 commit 6d37c44

26 files changed

+3974
-2103
lines changed

‎documentation/docs/04-Guides/04-Theming/03-Generated styles/02-Fonts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Where `sizesValues` is an array of numbers, `sizeValue` is an item of `sizeValue
4040

4141
| font name | Generated style |
4242
|----------------------------|------------------------------|
43-
| fonts.size__sizesValue_ | { fontSize: _sizeValue_ } |
44-
| fonts._colorsKey_ | { color: _colorsValue_ } |
43+
| fonts.size__sizesValue_ | \{ fontSize: _sizeValue_ \} |
44+
| fonts._colorsKey_ | \{ color: _colorsValue_ \} |
4545

4646
## Static fonts
4747
Some fonts styles, such as the `fontWeight` property of a text style, don't require dynamic generation.

‎documentation/docs/04-Guides/04-Theming/03-Generated styles/03-Backgrounds.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The generated styles take the following form:
3636

3737
| background name | Generated style |
3838
|---------------------------|-------------------------------------|
39-
| backgrounds._colorName_ | { backgroundColor: _colorValue_ } |
39+
| backgrounds._colorName_ | \{ backgroundColor: _colorValue_ \} |
4040

4141
These styles enable you to easily apply background colors to your components as needed.
4242

‎documentation/docs/04-Guides/04-Theming/03-Generated styles/04-Borders.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Where `widthsValues` and `radiusValues` are arrays of numbers, `widthValue` is a
4040

4141
| font name | Generated style |
4242
|-------------------------------|-----------------------------------|
43-
| borders.w__widthValue_ | { borderWidth: _widthValue_ } |
44-
| borders.rounded__radiusValue_ | { borderRadius: _radiusValue_ } |
45-
| borders._colorsKey_ | { borderColor: _colorsValue_ } |
43+
| borders.w__widthValue_ | \{ borderWidth: _widthValue_ \} |
44+
| borders.rounded__radiusValue_ | \{ borderRadius: _radiusValue_ \} |
45+
| borders._colorsKey_ | \{ borderColor: _colorsValue_ \} |
4646

4747

4848
## Static borders styles

‎documentation/docs/04-Guides/04-Theming/04-API.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ keywords: [theme, theming, configuration, config, api, reference, api reference]
1010

1111
### ColorConfig
1212

13-
| Key | Type | Description |
14-
|----------|------------------------|----------------------|
15-
| `colors` | Record<string, string> | Define global colors |
13+
| Key | Type | Description |
14+
|----------|--------------------------|----------------------|
15+
| `colors` | Record\<string, string\> | Define global colors |
1616

1717
### FontConfig
1818

19-
| Key | Type | Description |
20-
|----------|------------------------|-------------------------------------------------|
21-
| `sizes` | number[] | Define font sizes to generate associated style |
22-
| `colors` | Record<string, string> | Define font colors to generate associated style |
19+
| Key | Type | Description |
20+
|----------|--------------------------|-------------------------------------------------|
21+
| `sizes` | number[] | Define font sizes to generate associated style |
22+
| `colors` | Record\<string, string\> | Define font colors to generate associated style |
2323

2424
### GuttersConfig
2525

@@ -30,11 +30,11 @@ keywords: [theme, theming, configuration, config, api, reference, api reference]
3030

3131
### BordersConfig
3232

33-
| Key | Type | Description |
34-
|----------|------------------------|------------------------------------------------------------|
35-
| `widths` | number[] | Define sizes to generate associated styles (borderWidth) |
36-
| `radius` | number[] | Define radius to generate associated styles (borderRadius) |
37-
| `colors` | Record<string, string> | Define colors to generate associated styles (borderColor) |
33+
| Key | Type | Description |
34+
|----------|--------------------------|------------------------------------------------------------|
35+
| `widths` | number[] | Define sizes to generate associated styles (borderWidth) |
36+
| `radius` | number[] | Define radius to generate associated styles (borderRadius) |
37+
| `colors` | Record\<string, string\> | Define colors to generate associated styles (borderColor) |
3838

3939
### NavigationColorsConfig
4040

@@ -69,7 +69,7 @@ keywords: [theme, theming, configuration, config, api, reference, api reference]
6969
| fonts | [`Fonts`](/docs/theming/api-reference#fonts) |
7070
| backgrounds | [`Backgrounds`](/docs/theming/api-reference#backgrounds) |
7171
| borders | [`Borders`](/docs/theming/api-reference#borders) |
72-
| navigationTheme | [`NavigationTheme`](/docs/theming/api-reference#navigationTheme) |
72+
| navigationTheme | [`NavigationTheme`](/docs/theming/api-reference#navigationcolorsconfig) |
7373
| components | [`Components`](/docs/theming/api-reference#components) |
7474

7575
### Layout
@@ -89,7 +89,7 @@ The type of the generated styles is `Record<string, TextStyle>` but will be infe
8989

9090
### Backgrounds
9191
Generated styles provided by the `backgrounds` section of the theme configuration assist in applying background color to your components.
92-
The type of the generated styles is `Record<`bg_${string}`, {backGroundColor: string}>` but will be inferred by the `Backgrounds` type.
92+
The type of the generated styles is `Record<`bg_$\{string\}`, {backGroundColor: string}>` but will be inferred by the `Backgrounds` type.
9393

9494
### Borders
9595
Generated styles provided by the `borders` section of the theme configuration assist in applying border radius, width and color to your components.
@@ -100,4 +100,3 @@ Generated styles provided by the `navigationColors` section of the theme configu
100100

101101
### Components
102102
Generated styles provided by the `components` file of the theme configuration assist in applying styles to specific components.
103-

‎documentation/docusaurus.config.js

Lines changed: 0 additions & 145 deletions
This file was deleted.

‎documentation/docusaurus.config.ts

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
import type { Config } from '@docusaurus/types';
2+
import { themes as prismThemes } from 'prism-react-renderer';
3+
4+
export default {
5+
title: 'The React Native Boilerplate',
6+
tagline: 'Simple, Lightweight and Scalable.',
7+
url: 'https://thecodingmachine.github.io',
8+
baseUrl: '/react-native-boilerplate/',
9+
onBrokenLinks: 'throw',
10+
onBrokenMarkdownLinks: 'warn',
11+
favicon: 'img/TOM-small.webp',
12+
organizationName: 'thecodingmachine',
13+
projectName: 'react-native-boilerplate',
14+
i18n: {
15+
defaultLocale: 'en',
16+
locales: ['en'],
17+
},
18+
plugins: [
19+
async function myPlugin() {
20+
return {
21+
name: 'docusaurus-tailwindcss',
22+
configurePostCss(postcssOptions) {
23+
// eslint-disable-next-line global-require,import/no-extraneous-dependencies
24+
postcssOptions.plugins.push(require('tailwindcss'));
25+
// eslint-disable-next-line global-require,import/no-extraneous-dependencies
26+
postcssOptions.plugins.push(require('autoprefixer'));
27+
return postcssOptions;
28+
},
29+
};
30+
},
31+
],
32+
presets: [
33+
[
34+
'classic',
35+
/** @type {import('@docusaurus/preset-classic').Options} */
36+
({
37+
docs: {
38+
sidebarPath: require.resolve('./sidebars.js'),
39+
editUrl:
40+
'https://github.com/thecodingmachine/react-native-boilerplate/edit/main/website-documentation/docs',
41+
},
42+
blog: {
43+
showReadingTime: true,
44+
editUrl:
45+
'https://github.com/thecodingmachine/react-native-boilerplate/edit/main/website-documentation/blog',
46+
},
47+
theme: {
48+
customCss: require.resolve('./src/css/custom.css'),
49+
},
50+
}),
51+
],
52+
],
53+
54+
themeConfig: {
55+
algolia: {
56+
appId: '9PEYN0H12D',
57+
indexName: 'rnboilerplate',
58+
apiKey: '983439b6ebef49ed3394ecfa290f1c6a',
59+
contextualSearch: true,
60+
},
61+
colorMode: {
62+
defaultMode: 'dark',
63+
disableSwitch: false,
64+
respectPrefersColorScheme: false,
65+
},
66+
navbar: {
67+
title: 'React Native Boilerplate',
68+
logo: {
69+
alt: 'octopus tentacle logo',
70+
src: 'img/TOM-small.webp',
71+
},
72+
items: [
73+
{
74+
type: 'doc',
75+
docId: 'getting-started',
76+
position: 'left',
77+
label: 'Docs',
78+
},
79+
{ to: '/blog', label: 'Blog', position: 'left' },
80+
{
81+
to: 'https://github.com/thecodingmachine/react-native-boilerplate',
82+
label: ' ',
83+
className: 'header-github-link group',
84+
position: 'right',
85+
},
86+
],
87+
},
88+
footer: {
89+
style: 'dark',
90+
links: [
91+
{
92+
title: 'Features',
93+
items: [
94+
{
95+
label: 'Javascript or TypeScript ? You choose !',
96+
to: '/docs/installation#using-the-boilerplate',
97+
},
98+
{
99+
label: 'Navigation',
100+
to: '/docs/navigate',
101+
},
102+
{
103+
label: 'Data fetching',
104+
to: '/docs/data-fetching',
105+
},
106+
{
107+
label: 'Internationalization',
108+
to: '/docs/internationalization',
109+
},
110+
{
111+
label: 'Multi theming',
112+
to: '/docs/theming/how-to-use',
113+
},
114+
],
115+
},
116+
{
117+
title: 'More',
118+
items: [
119+
{
120+
label: 'Blog',
121+
to: '/blog',
122+
},
123+
{
124+
label: 'GitHub',
125+
to: 'https://github.com/thecodingmachine/react-native-boilerplate',
126+
},
127+
],
128+
},
129+
],
130+
copyright: `Copyright © ${new Date().getFullYear()} React Native Boilerplate, by TheCodingMachine. Built with Docusaurus.`,
131+
},
132+
prism: {
133+
theme: prismThemes.github,
134+
darkTheme: prismThemes.dracula,
135+
},
136+
},
137+
} satisfies Config;

0 commit comments

Comments
 (0)