Skip to content

Document static server requirements #69

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.

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

Closed
Fil opened this issue Oct 26, 2023 · 3 comments
Closed

Document static server requirements #69

Fil opened this issue Oct 26, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@Fil
Copy link
Contributor

Fil commented Oct 26, 2023

We should list expectations on how to serve the built site.

For example, the side bar links to URL /contributing but the server must respond with the contents of the contributing.html file; if you use python3 -m http.server or npx live-server to serve the dist folder, this results in a 404 when using the navigation bar.

Would it make sense to have a yarn serve command that serves the built site (with http-server or npx http-server, or with a custom ./src/serve.ts)?

@Fil Fil added the documentation Improvements or additions to documentation label Oct 26, 2023
@mbostock mbostock changed the title static server requirements? Document static server requirements Oct 26, 2023
@cinxmo cinxmo self-assigned this Oct 31, 2023
@cinxmo cinxmo removed their assignment Jan 16, 2024
@Fil
Copy link
Contributor Author

Fil commented Jan 22, 2024

For example when pushing a site to vercel, you need to add a vercel.json file with the {cleanUrls: true} option.

@mbostock
Copy link
Member

I feel like this should be closed in favor of #92.

@mbostock
Copy link
Member

mbostock commented Feb 1, 2024

Closing in favor of #92.

@mbostock mbostock closed this as completed Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants