Skip to content

Commit 8a44553

Browse files
committed
fix
1 parent c223b00 commit 8a44553

File tree

1 file changed

+2
-26
lines changed

1 file changed

+2
-26
lines changed

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Get your Google Maps API Key. Make sure the "Maps JavaScript API" is enabled for
6868

6969
## Documentation
7070

71-
For detailed documentation, component references, and examples, please visit the **[Documentation Website](https://your-github-username.github.io/svelte-google-maps-api/)** (Replace with actual link after deployment).
71+
For detailed documentation, component references, and examples, please visit the **[Documentation Website](https://skyt-a.github.io/svelte-google-maps-api/docs)** (Replace with actual link after deployment).
7272

7373
## Components
7474

@@ -89,31 +89,7 @@ This library provides the following components (and more):
8989
## Contributing
9090

9191
Contributions are welcome! Please feel free to open an issue or submit a pull request.
92-
93-
## Building the Documentation
94-
95-
To build the static documentation site (output to the `docs` directory):
96-
97-
```bash
98-
pnpm run build
99-
```
100-
101-
This command typically runs `vite build`, which uses the `adapter-static` configured in `svelte.config.js`.
102-
103-
## Deploying to GitHub Pages
104-
105-
1. **Build the site:** Run `pnpm run build` (or `npm run build`/`yarn build`). This will generate the static files in the `docs` directory.
106-
2. **Commit the `docs` directory:** Add the `docs` directory to your git commit.
107-
3. **Push to GitHub:** Push your changes to the `main` (or your default) branch.
108-
4. **Configure GitHub Pages:**
109-
* Go to your repository settings on GitHub.
110-
* Navigate to the "Pages" section.
111-
* Under "Build and deployment", select "Deploy from a branch" as the source.
112-
* Choose the branch you pushed to (e.g., `main`) and select the `/docs` folder as the publishing source.
113-
* Save the changes.
114-
5. **Access the site:** GitHub Pages will deploy your site. The URL will be something like `https://<your-username>.github.io/<repository-name>/docs/`. (Update the link in the main README accordingly).
115-
116-
*Alternatively, you can set up a GitHub Action to automate the build and deployment process to the `gh-pages` branch.*
92+
11793

11894
## License
11995

0 commit comments

Comments
 (0)