https://github.com/effector/docs-v23
Documentation for the previous release of effector
https://github.com/effector/docs-v23
Last synced: 2 months ago
JSON representation
Documentation for the previous release of effector
- Host: GitHub
- URL: https://github.com/effector/docs-v23
- Owner: effector
- Created: 2024-06-06T17:55:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-03T19:35:24.000Z (8 months ago)
- Last Synced: 2025-02-17T02:05:44.892Z (2 months ago)
- Language: Astro
- Homepage: https://v23.effector.dev/
- Size: 1.24 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# Documentation
## Content files
All files of the content can be written using MD or MDX inside `src/content/docs/[lang]`.
Astro can find localized version via the same slug (path to the document) in the another directory:
- `src/content/docs/[lang]/[slug].md` (_or `.mdx`_)
- `src/content/docs/en/api/effector/clearNode.md`
- `src/content/docs/ru/api/effector/clearNode.md`
## Configuration
The most basic setup is in `src/consts.ts`.
Translation of the UI elements is in `src/languages.ts`.
All navigation structure is in `src/navigation.ts`.
## Run
Simply install the `pnpm` and run:
```shell
pnpm install
pnpm start
```
To fetch commits history, you need Github Personal Access Token. Just add it:
```shell
GITHUB_TOKEN=github_pat_REDACTED_TOKEN pnpm start
```
### Search
By default search disabled on the local machine due to index requirements. But you can enable it by following steps:
1. Build the docs — `COMPRESS=false pnpm build`
2. Start search serve server — `pnpm search:dev`
3. Start astro with env parameter `PUBLIC_SEARCH=true pnpm dev`
`COMPRESS=false` disables compressing, to speed up build.