Skip to content
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

[astro] Docs: Fix md rendering and build #929

Merged
merged 2 commits into from
Jul 19, 2023

Conversation

edivados
Copy link
Contributor

@edivados edivados commented Jul 6, 2023

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • infrastructure changes
  • Other... Please describe:

What is the current behavior?

  • .md pages not rendering
  • build not working

What is the new behavior?

  • .md pages rendering
  • build works

Other information

Astro includes a plugin astro:markdown that when removed seems to solve the rendering problem.
Maybe it is better to do the removal in the start package.

There are some twoslash errors on the following pages. (All should disappear with #919)

  • core-concepts/state-management.mdx
  • api/createRouteAction.md
  • api/server.md

Build

Looks like entry-server.tsx and entry-client.tsx are being picked up as routes and because of this the generated dist/chunks/pages/handler.js makes calls to uninitialized stuff. Moved both files to src and changed appRoot and routesDir accordingly.

At first I tried moving all routes to a subdirectory docs/routes but this just broke navigation and fetch calls didn't return anything. Maybe you @ryansolid can give me some insight on this? The urls generated by the Nav compnent were wrong after moving the pages to docs/routes... 😑

@edivados edivados changed the title [astro] Docs: Fix md rendering [astro] Docs: Fix md rendering and prod build Jul 14, 2023
@edivados edivados changed the title [astro] Docs: Fix md rendering and prod build [astro] Docs: Fix md rendering and build Jul 15, 2023
@ryansolid ryansolid merged commit cecd048 into solidjs:astro Jul 19, 2023
1 of 3 checks passed
@ryansolid
Copy link
Member

Thank you

@edivados edivados deleted the astro-docs branch July 21, 2023 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants