70 | {todos.map(todo => (
71 |
74 | );
75 | }
76 | ```
77 |
--------------------------------------------------------------------------------
/docs/api/rx.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: rx
3 | title: Rx
4 | hide_title: true
5 | sidebar_label: Rx
6 | ---
7 |
8 | # Rx
9 | `Rx` is a convenience re-export of rxjs. Check [this issue](https://github.com/ReactiveX/rxjs/issues/3622) for motivation.
10 |
11 | The entry point contains:
12 | - all exports from `rxjs/operators`
13 | - Following exports from `rxjs`:
14 | `Subject`, `forkJoin`, `empty`, `of`, `timer`, `from`, `defer`, `Observable`, `interval`
15 | - Renamed exports from `rxjs`:
16 | - `concat` -> `concatObs`
17 | - `merge` -> `mergeObs`
18 | - `race` -> `raceObs`
19 | - `throwError` -> `throwObs`
20 | - Following exports from `rxjs/internal-compatibility`:
21 | `fromPromise`
22 |
23 | ## Additional operators
24 |
25 | ### `ofType(actionCreator)`
26 | Filter actions based on the provided action creator or action creators.
27 | #### Arguments
28 | 1. `actionCreator: AC | AC[]` - the action creator or array of action creators.
29 | #### Returns
30 | `{OperatorFunction}` - the rxjs operator function.
31 |
32 | #### Example
33 | ```ts
34 | // symbol.ts
35 | export const MySymbol = Symbol('my');
36 |
37 | // interface.ts
38 | import { createModule } from 'typeless';
39 | import { MySymbol } from './symbol';
40 |
41 | export const [handle, MyActions] = createModule(MySymbol)
42 | .withActions({
43 | loadUser: null,
44 | userLoaded: (user: User) => ({ payload: { user } }),
45 | cancel: null,
46 | });
47 |
48 | // module.ts
49 | import * as Rx from 'typeless/rx';
50 | import { handle, MyActions } from 'typeless';
51 |
52 | handle.epic()
53 | .on(MyActions.loadUser, (_, { action$ }) =>
54 | API.loadUser().pipe(
55 | Rx.map(user => MyActions.userLoader(user)),
56 | // cancel operation if `MyActions.cancel()` is dispatched
57 | Rx.takeUntil(action$.pipe(Rx.ofType(MyActions.cancel)))
58 | )
59 | );
60 | ```
61 |
62 | ### waitForType(actionCreator)
63 | Wait for a single action creator.
64 | #### Arguments
65 | 1. `actionCreator: AC ` - the action creator to wait for.
66 | #### Returns
67 | `{OperatorFunction}` - the rxjs operator function.
68 |
69 | #### Example
70 | ```ts
71 | // symbol.ts
72 | export const MySymbol = Symbol('my');
73 |
74 | // interface.ts
75 | import { createModule } from 'typeless';
76 | import { MySymbol } from './symbol';
77 |
78 | export const [handle, MyActions] = createModule(MySymbol)
79 | .withActions({
80 | deleteUser: null,
81 | userDeleted: null,
82 | errorOccurred: null,
83 | confirmDelete: (confirm: boolean) => ({ payload: { confirm } }),
84 | });
85 |
86 | // module.ts
87 | import * as Rx from 'typeless/rx';
88 | import { handle, MyActions } from 'typeless';
89 |
90 | handle.epic()
91 | // show a confirmation dialog and wait for Yes/No click
92 | .on(MyActions.deleteUser, (_, { action$ }) =>
93 | action$.pipe(
94 | Rx.waitForType(MyActions.confirmDelete),
95 | Rx.filter(action => action.payload.confirm)
96 | Rx.mergeMap(() => API.deleteUser()),
97 | Rx.mapTo(MyActions.userDeleted()),
98 | Rx.catchError(e => {
99 | console.error(e);
100 | return Rx.of(MyActions.errorOccurred());
101 | })
102 | )
103 | );
104 | ```
--------------------------------------------------------------------------------
/docs/api/useActions.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: useActions
3 | title: useActions
4 | hide_title: true
5 | sidebar_label: useActions
6 | ---
7 |
8 |
9 |
10 | # useActions(actionCreators)
11 | React Hook for binding actions creators with `dispatch`.
12 |
13 | #### Arguments
14 | 1. `actionCreators: {[action: string]: ActionCreator}` - the action creators created by [`createModule`](createModule).
15 |
16 | #### Returns
17 | `{[action: string]: Function}` - the mapped actions.
18 |
19 |
20 | #### Example
21 |
22 | ```tsx
23 | // symbol.ts
24 | export const CounterSymbol = Symbol('counter');
25 |
26 | // interface.ts
27 | import { createModule } from 'typeless';
28 | import { CounterSymbol } from './symbol';
29 |
30 | export const [handle, CounterActions] = createModule(CounterSymbol)
31 | .withActions({
32 | increase: null,
33 | });
34 |
35 | // module.tsx
36 | import { CounterActions } from './interface';
37 |
38 | export function Counter() {
39 | const { increase } = useActions(CounterActions);
40 | return
41 | }
42 | ```
43 |
--------------------------------------------------------------------------------
/docs/api/useMappedState.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: useMappedState
3 | title: useMappedState
4 | hide_title: true
5 | sidebar_label: useMappedState
6 | ---
7 |
8 | # useMappedState(stateGetters, mapperFn[, equalityFn][, deps])
9 |
10 | React Hook for accessing the State.
11 | For most use cases it's enough to use a shorthand version `getCounterState.useState()`.
12 |
13 | #### Arguments
14 |
15 | 1. `stateGetters: Array
60 |
63 |
65 | );
66 | }
67 | ```
68 |
--------------------------------------------------------------------------------
/docs/api/useSelector.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: useSelector
3 | title: useSelector
4 | hide_title: true
5 | sidebar_label: useSelector
6 | ---
7 |
8 | # useSelector(selector[, equalityFn])
9 |
10 | React Hook for accessing the Selector result.
11 |
12 | #### Arguments
13 |
14 | 1. `selector: Selector`- a selector function created with `createSelector`.
15 | 2. `equalityFn?: (a: unknown, b: unknown) => boolean` - the function for checking that new result value of `Selector` equals the old value. For more info: [useMappedState](/api/useMappedState)
16 |
17 | #### Returns
18 |
19 | `{object}` - the object returned by `Selector`.
20 |
21 | #### Example
22 |
23 | Full example: [`createSelector`](/api/createSelector#example)
24 |
25 | ```tsx
26 | // components/TodoList.tsx
27 | function TodoList() {
28 | // use your selector with useSelector
29 | const todos = useSelector(getTodos);
30 | return (
31 | count: {count}
64 |
32 | {todos.map(todo => (
33 |
36 | );
37 | }
38 | ```
39 |
--------------------------------------------------------------------------------
/docs/introduction/examples.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: examples
3 | title: Examples
4 | hide_title: true
5 | sidebar_label: Examples
6 | ---
7 |
8 | # Examples
9 |
10 | ### Counter
11 | A simple button with an async counter.
12 | Live demo
13 | Source code
14 |
15 | ----
16 |
17 | ### Real API
18 | Load 😺 from API with cancellation and retry on errors.
19 | Live demo
20 | Source code
21 |
22 |
23 | ----
24 |
25 | ### Code-Splitting
26 | A simple demo with code splitting for modules using React Suspense and React Lazy.
27 | Live demo
28 | Source code
29 |
30 | ----
31 |
32 | ### Basic HMR
33 | A basic demo with HMR support.
34 | Live demo
35 | Source code
36 |
37 | ----
38 |
39 | ### Sockets with HMR
40 | Subscribe to the socket with developer-friendly HMR support.
41 | Create epic handlers that are reloadable or non-reloadable.
42 | Live demo
43 | Source code
44 |
45 | ----
46 |
47 | ### Routing
48 | A simple example of routing with `typeless-router`
49 | Live demo
50 | Source code
51 |
52 | ----
53 |
54 | ### Form
55 | A simple example of forms with `typeless-form`
56 | Live demo
57 | Source code
58 |
--------------------------------------------------------------------------------
/docs/introduction/motivation.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: motivation
3 | title: Motivation
4 | hide_title: true
5 | sidebar_label: Motivation
6 | ---
7 |
8 | # Motivation
9 |
10 | ## Problems
11 |
12 | Creating Redux applications in TypeScript can be overwhelming. Many developers face the same problems:
13 |
14 | - **Too much boilerplate code**
15 | Creating actions types, actions creators, defining RootAction and RootState types require a lot of typing!
16 |
17 | - **Double annotation problem**
18 | Many libraries work nice with JavaScript, but they are problematic with TypeScript.
19 | When using [redux-saga](https://github.com/redux-saga/redux-saga) you can't infer types from `yield` statements, and you must add extra annotations to your code. It can cause potential bugs if you provide the wrong type.
20 | The `connect` function must match exactly `props` of your connected component. Any small mistake causes a big compiler error if there are many properties. Fixing such mistakes is tedious and frustrating.
21 |
22 | - **Too many libraries**
23 | "What libraries should I use? redux-observables, redux-saga, redux-thunk, redux-xxx?"
24 | Over-analyzing can cause [Analysis paralysis](https://en.wikipedia.org/wiki/Analysis_paralysis).
25 |
26 | - **Lack of guidelines**
27 | There are no official guidelines on how to lazy load reducers, sagas or epics. Code splitting is critical when scaling bigger apps.
28 | Custom solutions for lazy loading usually don't work with HMR causing poor developer experience.
29 |
30 | ## Base Concepts
31 |
32 | - **Designed for TypeScript**
33 | All APIs are designed for TypeScript and type-safety:
34 |
35 | - TypeScript will boost your productivity, not slows you down.
36 | - Only the necessary annotations are required: state, action arguments.
37 | - No typecasting. Everything is inferred automatically. 95% of the code looks like pure JavaScript.
38 | - No RootAction, RootEpic, RootState or other helper types.
39 |
40 | - **Provide all building blocks**
41 | Typeless includes everything to build mid-sized or enterprise level apps.
42 | You don't need to rely on multiple small libraries.
43 |
44 | - **Modularity**
45 | Proper modularity is critical for building scalable apps.
46 | There is no need to create root files for epics, reducers, types, etc. Once you create a new module, you can attach it from any place. Similar to standard React components.
47 |
48 | - **Opinionated**
49 | All common use cases and problems are solved by default. No need to over-think how to fix trivial issues.
50 | All recommendations and best practices are provided!
51 |
--------------------------------------------------------------------------------
/docs/introduction/roadmap.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: roadmap
3 | title: Roadmap
4 | hide_title: true
5 | sidebar_label: Roadmap
6 | ---
7 |
8 | # Roadmap
9 |
10 | - **Server-side rendering**
11 | It cannot be implemented at this moment. `React.Lazy` doesn't support SSR.
12 | - **Testing example**
13 | Work in progress. Everything is testable, but need to create explicit examples.
14 |
--------------------------------------------------------------------------------
/docs/introduction/starter-kits.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: starter-kits
3 | title: Starter Kits
4 | hide_title: true
5 | sidebar_label: Starters Kits
6 | ---
7 |
8 | # Starter Kits
9 |
10 | ### Create React App
11 | [Repository](https://github.com/typeless-js/create-react-app-starter)
12 | Starter kit based on Create React App.
13 | Features:
14 | - example user module
15 | - routing for auth/anonymous users
16 | - forms
17 | - lazy modules
18 | - blueprints
19 |
--------------------------------------------------------------------------------
/docs/using-typeless/actions.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: actions
3 | title: Actions
4 | hide_title: true
5 | sidebar_label: Actions
6 | ---
7 |
8 | # Actions
--------------------------------------------------------------------------------
/docs/using-typeless/code-splitting.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: code-splitting
3 | title: Code-Splitting
4 | hide_title: true
5 | sidebar_label: Code-Splitting
6 | ---
7 |
8 | # Code-Splitting
9 | Reducers and epics are part of your React components. You can use [React.lazy()](https://reactjs.org/docs/code-splitting.html) to implement code-splitting.
10 | Check [Code-Splitting](/introduction/examples#code-splitting) for full working example.
11 |
12 | #### Example
13 |
14 |
15 | ```tsx
16 | // src/features/foo/module.tsx
17 |
18 | import { useModule } from './interface'
19 |
20 | export default function FooModule() {
21 | useModule();
22 |
23 | return Foo hidden
;
36 | }
37 | ```
38 |
39 |
--------------------------------------------------------------------------------
/docs/using-typeless/hmr.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: hmr
3 | title: HMR
4 | hide_title: true
5 | sidebar_label: HMR
6 | ---
7 |
8 | # HMR
9 | To enable Hot Module Replacement, you must wrap your root app with `
18 | data.actions.blur(name)}
21 | onChange={e => {
22 | data.actions.change(name, e.target.value);
23 | }}
24 | {...rest}
25 | />
26 | {hasError &&
28 | );
29 | };
30 |
--------------------------------------------------------------------------------
/examples/src/basic-form/features/example/form.ts:
--------------------------------------------------------------------------------
1 | import { createForm } from 'typeless-form';
2 | import { ExampleFormSymbol } from './symbol';
3 |
4 | interface ExampleForm {
5 | foo: string;
6 | bar: string;
7 | }
8 |
9 | export const [
10 | useExampleForm,
11 | ExampleFormActions,
12 | getExampleFormState,
13 | ExampleFormProvider,
14 | ] = createForm{data.errors[name]}
}
27 |
10 |
11 |
16 | );
17 | }
18 |
--------------------------------------------------------------------------------
/examples/src/basic-hmr/features/counter/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { CounterSymbol } from './symbol';
3 |
4 | export const [useModule, CounterActions, getCounterState] = createModule(
5 | CounterSymbol
6 | )
7 | .withActions({
8 | increase: null,
9 | })
10 | .withStatecount: {count}
12 |
13 | Edit this text in your IDE. The counter value should remain the same.
14 |
15 |
13 | page a | page b
14 |
15 | Current location: {location.pathname} 16 |
17 | );
18 | }
19 |
20 | ReactDOM.render(
21 | 15 | Current location: {location.pathname} 16 |
45 | Show View:{' '}
46 |
58 |
61 |
59 | Loading...
}>{renderContent()}
60 |
62 | Open Dev Tools, and change Network speed to "Slow 3G".
63 |
64 | Choose an option from the above select. 65 |
66 |
67 | );
68 | }
69 |
--------------------------------------------------------------------------------
/examples/src/code-splitting/features/main/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { MainSymbol } from './symbol';
3 |
4 | export const [useModule, MainActions, getMainState] = createModule(MainSymbol)
5 | .withActions({
6 | show: (viewType: ViewType) => ({ payload: { viewType } }),
7 | })
8 | .withState64 | Choose an option from the above select. 65 |
11 | Module A.
12 | Counter {counter}
13 | 14 |
15 | );
16 | }
17 |
--------------------------------------------------------------------------------
/examples/src/code-splitting/features/subA/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { SubASymbol } from './symbol';
3 |
4 | export const [useModule, SubAActions, getSubAState] = createModule(SubASymbol)
5 | .withActions({
6 | increase: null,
7 | })
8 | .withState12 | Counter {counter}
13 | 14 |
11 | Module B.
12 | Counter {counter}
13 |
14 | Counter will reset if you unmount this module. 15 |
16 | );
17 | }
18 |
--------------------------------------------------------------------------------
/examples/src/code-splitting/features/subB/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { SubBSymbol } from './symbol';
3 |
4 | export const [useModule, SubBActions, getSubBState] = createModule(SubBSymbol)
5 | .withActions({
6 | decrease: null,
7 | $unmounting: null,
8 | })
9 | .withState12 | Counter {counter}
13 |
14 | Counter will reset if you unmount this module. 15 |
11 | Module C.
12 | Counter {counter}
13 | 14 |
15 | );
16 | }
17 |
--------------------------------------------------------------------------------
/examples/src/code-splitting/features/subC/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { SubCSymbol } from './symbol';
3 |
4 | export const [useModule, SubCActions, getSubCState] = createModule(SubCSymbol)
5 | .withActions({
6 | double: null,
7 | })
8 | .withState12 | Counter {counter}
13 | 14 |
63 |
66 |
68 | );
69 | }
70 |
71 | ReactDOM.render(
72 | count: {count}
67 | No cat loaded yet
25 | )}
26 |
29 |
30 | );
31 | }
32 | case 'loading': {
33 | return (
34 | <>
35 |
36 |
37 |
38 | );
39 | }
40 | case 'error': {
41 | return (
42 | <>
43 |
44 | 😿
45 | An error occurred: {error} 46 |
47 |
48 |
49 | );
50 | }
51 | }
52 | };
53 |
54 | return (
55 | 45 | An error occurred: {error} 46 |
66 | {renderContent()}
67 |
71 | );
72 | }
73 |
--------------------------------------------------------------------------------
/examples/src/real-api/features/cat/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { CatSymbol } from './symbol';
3 |
4 | export const [useModule, CatActions, getCatState] = createModule(CatSymbol)
5 | .withActions({
6 | loadCat: null,
7 | cancel: null,
8 | catLoaded: (cat: Cat) => ({ payload: { cat } }),
9 | errorOcurred: (error: string) => ({ payload: { error } }),
10 | })
11 | .withState
68 | Click on load multiple times. There is 50% chance for errors.
69 |
70 |
11 |
15 |
19 |
30 | 31 | 32 | Open
34 | Also, check comments in the source code. 35 | 36 |
37 | );
38 | }
39 |
--------------------------------------------------------------------------------
/examples/src/socket-hmr/features/socket/interface.ts:
--------------------------------------------------------------------------------
1 | import { createModule } from 'typeless';
2 | import { SocketSymbol } from './symbol';
3 |
4 | export const [useModule, SocketActions, getSocketState] = createModule(
5 | SocketSymbol
6 | )
7 | .withActions({
8 | messageReceived: (container: 'a' | 'b' | 'c', text: string) => ({
9 | payload: { container, text },
10 | }),
11 | startC: null,
12 | stopC: null,
13 | $remounted: null,
14 | $mounted: null,
15 | $unmounted: null,
16 | })
17 | .withStateModule A
12 |HMR reloads ignored
13 | 14 |15 |
Module B
16 |HMR reloads handled
17 | 18 |19 |
Module C
20 |
21 | HMR reloads handled
Start/stop socket
22 |
30 | 31 | 32 | Open
src/features/components/module.tsx and edit{' '}
33 | CHANGE_ME to trigger HMR. 34 | Also, check comments in the source code. 35 | 36 |
59 |
60 |
61 | );
62 | }
63 |
64 | // initial render
65 | renderWithProvider({count}
;
47 | }
48 | it('should prevent re-render with equalityFn', () => {
49 | act(() => {
50 | registry.dispatch(Actions.increment());
51 | });
52 | expect(renderCount).toBe(1);
53 | });
54 | });
55 |
--------------------------------------------------------------------------------
/packages/typeless/__tests__/unit/util.test.ts:
--------------------------------------------------------------------------------
1 | import { objectIs } from '../../src/utils';
2 |
3 | describe('objectIs', () => {
4 | // ref. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is
5 |
6 | const obj = { x: 1 };
7 | const truthyCases = [
8 | { description: 'same string', a: 'foo', b: 'foo' },
9 | { description: 'same BigInt', a: BigInt(1), b: BigInt(1) },
10 | { description: 'same referenced object', a: obj, b: obj },
11 | { description: 'both null', a: null, b: null },
12 | { description: 'both NaN', a: NaN, b: NaN },
13 | { description: 'both minus zero value', a: -0, b: -0 },
14 | ];
15 | truthyCases.forEach(({ description, a, b }) => {
16 | it(`should return true called with ${description}`, () => {
17 | expect(objectIs(a, b)).toBeTruthy();
18 | });
19 | });
20 |
21 | const falsyCases = [
22 | { description: 'different reference object', a: [42], b: [42] },
23 | { description: 'different number', a: 0, b: 1 },
24 | { description: 'zero and plus zero value', a: 0, b: -0 },
25 | ];
26 | falsyCases.forEach(({ description, a, b }) => {
27 | it(`should return false called with ${description}`, () => {
28 | expect(objectIs(a, b)).toBeFalsy();
29 | });
30 | });
31 | });
32 |
--------------------------------------------------------------------------------
/packages/typeless/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "typeless",
3 | "version": "1.7.0",
4 | "description": "",
5 | "main": "dist/index.js",
6 | "module": "dist/es/index.js",
7 | "jsnext:main": "dist/es/index.js",
8 | "sideEffects": false,
9 | "scripts": {
10 | "lint": "tslint -t codeFrame 'src/**/*.ts' '__tests__/**/*.ts'",
11 | "_format-base": "prettier \"./**/*.{ts,tsx,json}\"",
12 | "check-format": "yarn _format-base --list-different",
13 | "fix-format": "yarn _format-base --write",
14 | "jest": "jest",
15 | "test": "yarn run check-format && yarn run lint && yarn run jest --coverage --no-cache",
16 | "clean": "rimraf dist *.tsbuildinfo"
17 | },
18 | "author": "Łukasz Sentkiewicz
41 |
42 |
50 |
51 | );
52 | }
53 |
54 | module.exports = Help;
55 |
--------------------------------------------------------------------------------
/website/pages/en/users.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require('react');
9 |
10 | const CompLibrary = require('../../core/CompLibrary.js');
11 |
12 | const Container = CompLibrary.Container;
13 |
14 | class Users extends React.Component {
15 | render() {
16 | const {config: siteConfig} = this.props;
17 | if ((siteConfig.users || []).length === 0) {
18 | return null;
19 | }
20 |
21 | const editUrl = `${siteConfig.repoUrl}/edit/master/website/siteConfig.js`;
22 | const showcase = siteConfig.users.map(user => (
23 |
24 |
43 |
44 |
46 |
49 | Need help?
45 |This project is maintained by a dedicated group of people.
47 |
30 |
31 |
43 |
44 | );
45 | }
46 | }
47 |
48 | module.exports = Users;
49 |
--------------------------------------------------------------------------------
/website/sidebars.json:
--------------------------------------------------------------------------------
1 | {
2 | "docs": {
3 | "Introduction": [
4 | "introduction/quick-start",
5 | "introduction/motivation",
6 | "introduction/examples",
7 | "introduction/starter-kits",
8 | "introduction/roadmap"
9 | ],
10 | "Using typeless": [
11 | "using-typeless/hmr",
12 | "using-typeless/code-splitting"
13 | ],
14 | "API Reference": [
15 | "api/createModule",
16 | "api/createSelector",
17 | "api/useActions",
18 | "api/useMappedState",
19 | "api/useSelector",
20 | "api/ChainedReducer",
21 | "api/Epic",
22 | "api/Handle",
23 | "api/rx"
24 | ],
25 | "API Reference (router)": [
26 | "api-router/createUseRouter",
27 | "api-router/RouterActions",
28 | "api-router/getRouterState",
29 | "api-router/Link"
30 | ],
31 | "API Reference (form)": [
32 | "api-form/createForm",
33 | "api-form/FormActions"
34 | ]
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/website/siteConfig.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | // See https://docusaurus.io/docs/site-config for all the possible
9 | // site configuration options.
10 |
11 | const siteConfig = {
12 | title: 'typeless', // Title for your website.
13 | tagline: 'Build scalable React apps with Typescript',
14 | url: 'https://typeless.js.com', // Your website URL
15 | baseUrl: '/', // Base URL for your project */
16 | // For github.io type URLs, you would set the url and baseUrl like:
17 | // url: 'https://facebook.github.io',
18 | // baseUrl: '/test-site/',
19 |
20 | docsUrl: '', // don't prefix docs URLs with /docs/
21 | // Used for publishing and more
22 | projectName: 'typeless',
23 | organizationName: 'typeless',
24 | // For top-level user or org sites, the organization is still the same.
25 | // e.g., for the https://JoelMarcey.github.io site, it would be set like...
26 | // organizationName: 'JoelMarcey'
27 |
28 | // For no header links in the top nav bar -> headerLinks: [],
29 | headerLinks: [
30 | { doc: 'introduction/quick-start', label: 'Docs' },
31 | { doc: 'api/createModule', label: 'API' },
32 | { href: 'https://www.github.com/typeless-js/typeless', label: 'Github' },
33 | ],
34 |
35 | /* path to images for header/footer */
36 | headerIcon: 'img/logo-white.svg',
37 | footerIcon: 'img/logo-white.svg',
38 | favicon: 'img/favicon.png',
39 |
40 | /* Colors for website */
41 | colors: {
42 | primaryColor: '#2C3D50',
43 | secondaryColor: '#720026',
44 | },
45 |
46 | /* Custom fonts for website */
47 | /*
48 | fonts: {
49 | myFont: [
50 | "Times New Roman",
51 | "Serif"
52 | ],
53 | myOtherFont: [
54 | "-apple-system",
55 | "system-ui"
56 | ]
57 | },
58 | */
59 |
60 | // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
61 | copyright: `Copyright © ${new Date().getFullYear()} Łukasz Sentkiewicz`,
62 |
63 | highlight: {
64 | // Highlight.js theme to use for syntax highlighting in code blocks.
65 | theme: 'monokai',
66 | },
67 |
68 | // Add custom scripts here that would be placed in
32 |
42 |
33 |
36 | Who is Using This?
34 |This project is used by many folks
35 |{showcase}
37 | Are you using this project?
38 | 39 | Add your company 40 | 41 |