Skip to content

[Doc] Bootstrap headless documentation #10843

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

Open
wants to merge 9 commits into
base: next
Choose a base branch
from
Open

[Doc] Bootstrap headless documentation #10843

wants to merge 9 commits into from

Conversation

djhi
Copy link
Collaborator

@djhi djhi commented Jul 21, 2025

Bootstrap headless documentation with Astro Starlight

How To Test

  • make doc-headless
  • Click the Guides & concepts button
  • In a new tab, enter http://localhost:4321/guides/crud/: note the sidenav scroll is sync

Additional Checks

  • The PR targets master for a bugfix or a documentation fix, or next for a feature
  • The PR includes unit tests (if not possible, describe why)
  • The PR includes one or several stories (if not possible, describe why)
  • The documentation is up to date

Also, please make sure to read the contributing guidelines.

Copy link
Contributor

@slax57 slax57 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise it indeed allows to get a really nice doc website with very few code, I love it!

Comment on lines 11 to 12
- [General Concepts](/guides/architecture)
- [Data Fetching](/guides/datafetchingguide)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's too bad we can't use links to the .md files, because it means the md docs won't be browsable from Github directly.
Can you try something like https://github.com/vernak2539/astro-rehype-relative-markdown-links?


For example, the following react-admin application:

```jsx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried using syntax like jsx{5} but unfortunately it does not work. Do you think we could add support for it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP Work In Progress
Development

Successfully merging this pull request may close these issues.

2 participants