Skip to content

docs: update instructions in writing-examples.md #896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
usefulthink merged 1 commit into from
Jan 14, 2026
Merged

docs: update instructions in writing-examples.md #896

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions docs/guides/writing-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,15 @@ files or using environment variables).
- Develop the example independently of the library as a standalone
mini-application (using `npm install` and `npm start` to start the vite
dev-server).
- If you install additional dependencies, the "Examples" section of [the website](https://visgl.github.io/react-google-maps/examples/) will not be able to host your example, but you can still [link to a CodeSandbox](https://codesandbox.io/docs/learn/devboxes/synced-templates#creating-a-synced-template) for the example.
- Edit the title, description and sourcecode links in the
`README.md`, `index.html`, and `./src/control-panel.tsx` files.

### Adding examples to the website

If you are adding an example with **no additional dependencies**:

1. Create the example page in `./website/src/examples/your-example-id.mdx`
2. Add the example to `./website/src/examples-sidebar.js`
3. Create a 400x400 px image for the overview page and place it in
- Create the example page in `./website/src/examples/your-example-id.mdx`
- Add the example to `./website/src/examples-sidebar.js`
- Create a 400x400 px image for the overview page and place it in
`./website/static/images/examples/your-example-id.jpg`
4. The whole website can be started in dev-mode by running `npm i` and
- The whole website can be started in dev-mode by running `npm i` and
`npm start` in the `./website` directory. The website build can be tested
by running `npm run build`.

If you are adding an example **with additional dependencies**:

1. Create a 400x400 px image for the overview page and place it in `./website/static/images/examples/your-example-id.jpg`
2. Add the example to `./website/src/examples-sidebar.js` as an [external link](https://docusaurus.io/docs/sidebar/items#sidebar-item-link) to [a CodeSandbox](https://codesandbox.io/docs/learn/devboxes/synced-templates#creating-a-synced-template) based on the title of your new example folder in the `./examples` folder.