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

feat: add Simple Layout without default styles and components #2640

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

totto2727
Copy link

@totto2727 totto2727 commented Nov 27, 2024

Overview

  • Addition of SimpleStarlightPage.astro file with non-user CSS styling and removal of all but the minimum required elements
  • Extracted part of Page.astro into a separate component

Although the appearance has not been directly changed, the order in which the CSS is loaded may have changed.

Details

A StarlightPage component already exists that provides layouts for custom pages.
However, if you want to display content across the full screen, I don't need the header and sidebars included in StarlightPage.

ex. Reveal.js slides, etc.

However, it is troublesome to set up the head from scratch just for that custom page, and there is more code to manage.
If possible, it is preferable to have the same structure as the page using the StarlightPage component.

So I added a component that provides only the minimum layout required.

If you already have a solution to this problem, I would appreciate it if you could let me know.

Copy link

changeset-bot bot commented Nov 27, 2024

🦋 Changeset detected

Latest commit: c004dc0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added i18n Anything to do with internationalization & translation efforts 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package labels Nov 27, 2024
Copy link

netlify bot commented Nov 27, 2024

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit c004dc0
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/674750fe6a67a00009ed36ff
😎 Deploy Preview https://deploy-preview-2640--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston
Copy link
Collaborator

Hello! Thank you for opening your first PR to Starlight! ✨

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any issues you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@astrobot-houston
Copy link
Collaborator

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en guides/pages.mdx Source changed, localizations will be marked as outdated.
ja guides/pages.mdx Localization changed, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link

Choose a reason for hiding this comment

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

This component is named StarlightHeadlessPage, but it is referred to as SimpleStarlightPage elsewhere.

padding-bottom: 3vh;
}
@media (min-width: 50em) {
[data-has-sidebar] {
Copy link

Choose a reason for hiding this comment

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

Suggested change
[data-has-sidebar] {
:global(:root[data-has-sidebar]) {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟 core Changes to Starlight’s main package 📚 docs Documentation website changes i18n Anything to do with internationalization & translation efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants