You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-26Lines changed: 2 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ Get your Google Maps API Key. Make sure the "Maps JavaScript API" is enabled for
68
68
69
69
## Documentation
70
70
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).
72
72
73
73
## Components
74
74
@@ -89,31 +89,7 @@ This library provides the following components (and more):
89
89
## Contributing
90
90
91
91
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.*
0 commit comments