search

mdx-js / mdx

Markdown for the component era
https://mdxjs.com
MIT License
17.76k stars 1.14k forks source link

Add GitHub pages #2377

Closed remcohaszing closed 1 year ago

remcohaszing commented 1 year ago

This requires additional changes in the repository GitHub Pages settings. Source needs to be set to GitHub Actions, and a custom domain needs to be configured.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
mdx ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 20, 2023 6:01pm
codecov-commenter commented 1 year ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (fdfe17b) to head (e613207). Report is 81 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2377 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 23 23 Lines 2531 2531 Branches 4 4 ========================================= Hits 2531 2531 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

wooorm commented 1 year ago

Thanks!

a custom domain needs to be configured.

Do you mean a CNAME file in public/?

remcohaszing commented 1 year ago

No, when using GitHub actions as a source, the custom domain must be configured under the pages settings.

wooorm commented 1 year ago

I think that’s the same thing? when you change the custom domain in the interface, it writes to a CNAME file? Or at least it always used to be that way?

Reason I specifically mentioned CNAME is because redeploys without the file would remove it again, I think. Perhaps they persist it now?

remcohaszing commented 1 year ago

I found it in the docs now:

Under "Custom domain", type your custom domain, then click Save. If you are publishing your site from a branch, this will create a commit that adds a CNAME file directly to the root of your source branch. If you are publishing your site with a custom GitHub Actions workflow, no CNAME file is created. For more information about your publishing source, see "Configuring a publishing source for your GitHub Pages site."