Skip to content

Commit ff0184f

Browse files
authored
docs: update instructions in writing-examples.md (#896)
Removed instructions for adding examples with additional dependencies as they no longer apply.
1 parent 551d932 commit ff0184f

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

docs/guides/writing-examples.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,15 @@ files or using environment variables).
4646
- Develop the example independently of the library as a standalone
4747
mini-application (using `npm install` and `npm start` to start the vite
4848
dev-server).
49-
- 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.
5049
- Edit the title, description and sourcecode links in the
5150
`README.md`, `index.html`, and `./src/control-panel.tsx` files.
5251

5352
### Adding examples to the website
5453

55-
If you are adding an example with **no additional dependencies**:
56-
57-
1. Create the example page in `./website/src/examples/your-example-id.mdx`
58-
2. Add the example to `./website/src/examples-sidebar.js`
59-
3. Create a 400x400 px image for the overview page and place it in
54+
- Create the example page in `./website/src/examples/your-example-id.mdx`
55+
- Add the example to `./website/src/examples-sidebar.js`
56+
- Create a 400x400 px image for the overview page and place it in
6057
`./website/static/images/examples/your-example-id.jpg`
61-
4. The whole website can be started in dev-mode by running `npm i` and
58+
- The whole website can be started in dev-mode by running `npm i` and
6259
`npm start` in the `./website` directory. The website build can be tested
6360
by running `npm run build`.
64-
65-
If you are adding an example **with additional dependencies**:
66-
67-
1. Create a 400x400 px image for the overview page and place it in `./website/static/images/examples/your-example-id.jpg`
68-
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.

0 commit comments

Comments
 (0)