react-native-video/docs/README.md at feat/web

mirror of https://github.com/zoriya/react-native-video.git synced 2026-06-18 08:21:17 +00:00

Files

T

Kamil Moskała 0b273d16de docs: refactor tabs (#4827 )

* docs: refactor tabs

* docs: update video-view docs

* docs: lowercase tabs

* feat(docs): add downloading section

* chore: add chapters example video

* docs: update sidebar type

* docs: update tab heading

* docs: add title to fundaments

* docs: lowercase plugin

* docs(sidebar): remove link to offline sdk

* docs: add `ads` tab

* chore: add `build` to eslint ignore

* docs: remove theme mermaid

* refactor: update deploy values

* chore: upper case tabs

* refactor: update configuration tabs name

* feat: add `ask for plugin` tab

* refactor: update analytics tab

* docs: update player class tip

* docs: make chapters paid

* docs: update utm's

* docs(downloading): update intro

* chore: bump `docusaurus-ui` package to 0.1.2

* fix: update paths

* docs: update dashes

* docs: update downloading events example imports

* docs: update readme

* docs: update case

* refactor: update intro & offer

2026-02-04 20:19:49 +01:00

1.3 KiB

Raw Permalink Blame History

Instalation

To install the dependencies, run at the root of the repository:

$ bun install

Development

To start a local development server with hot-reloading, run:

$ bun run start

Deployment

Deployment is handled via GitHub Actions. Upon pushing to the master branch content from the docs directory is automatically deployed to GitHub Pages.

Custom Props

Custom props are provided by the @widlarzgroup/docusaurus-ui package and allow you to display badges and other UI elements. Custom props can be defined in three places:

1. In `_category_.json` (for entire categories)

{
  "label": "Analytics",
  "position": 7,
  "customProps": {
    "badgeType": "new"
  }
}

2. In markdown frontmatter (for individual pages)

---
sidebar_position: 5
sidebar_label: Chapters
customProps:
  plan: pro
---

3. In `sidebars.ts` (for sidebar items)

{
  type: 'doc',
  id: 'some-doc',
  customProps: {
    badgeType: 'new'
  }
}

Available Custom Props

Prop	Values	Description
`badgeType`	`"new"`, `"preview"`	Displays a "NEW" or "PREVIEW" badge next to the item
`plan`	`"pro"`	Displays a "PRO" badge indicating premium/commercial feature

1.3 KiB Raw Permalink Blame History