Skip to content

docs: directive-syntax examples for guide component usage #6308

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Jul 23, 2025
Merged

docs: directive-syntax examples for guide component usage #6308

merged 13 commits into from
Jul 23, 2025

Conversation

gevann
Copy link
Contributor

@gevann gevann commented Jul 22, 2025

Problem
Documentation for the components available in guides is incomplete. Currently, only the <scalar-[name]>` custom-html syntax is shown.

Solution

With this PR examples for the :::directive{key=value} syntax is added`

Checklist

I've gone through the following:

  • I've added an explanation why this change is needed.
  • I've updated the documentation.

@scalar-docs Scalar Docs
Copy link

scalar-docs bot commented Jul 22, 2025 •
edited
Loading

Scalar Docs Preview

Project
guides.scalar.com

Commit
2a2370a

Status
✅ Ready

Preview
Open Preview

Updated (UTC): Jul 22, 2025, 4:09 PM

To edit notification comments on pull requests, go to your Scalar project settings

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 22, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 2a2370a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@gevann gevann changed the title Graeme/doc 3725 add documentation for all components docs: Add directive-syntax examples to guide component usage Jul 22, 2025
@relativeci RelativeCI
Copy link

relativeci bot commented Jul 22, 2025 •
edited
Loading

#11593 Bundle Size — 2.63MiB (-0.01%).

2a2370a(current) vs e982593 main#11591(baseline)

Warning

Bundle contains 1 duplicate package – View duplicate packages

Bundle metrics  Change 1 change Improvement 1 improvement
                 Current
#11593		      Baseline
#11591
Improvement  Initial JS 2.63MiB(-0.01%) 2.63MiB
No change  Initial CSS 0B 0B
No change  Cache Invalidation 100% 100%
No change  Chunks 1 1
No change  Assets 1 1
No change  Modules 1785 1785
No change  Duplicate Modules 0 0
No change  Duplicate Code 0% 0%
No change  Packages 168 168
No change  Duplicate Packages 1 1
Bundle size by type  Change 1 change Improvement 1 improvement
                 Current
#11593		      Baseline
#11591
Improvement  JS 2.63MiB (-0.01%) 2.63MiB

Bundle analysis report Branch graeme/doc-3725-add-documentatio... Project dashboard

Generated by RelativeCI Documentation Report issue

@gevann gevann force-pushed the graeme/doc-3725-add-documentation-for-all-components branch from 233e90b to 95ca3b4 Compare July 22, 2025 03:35
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 22, 2025 •
edited
Loading

Preview Examples

https://cb3dae1d-8f24-4e2b-9fe1-f367a66d2418--scalar-deploy-preview.netlify.app

@hanspagel hanspagel changed the title docs: Add directive-syntax examples to guide component usage docs: directive-syntax examples for guide component usage Jul 22, 2025
gevann added 13 commits July 22, 2025 09:06
@gevann
docs(guides, components): create card entry
be13626
@gevann
docs(guides, components): create details entry
28e69f4
@gevann
docs(guides, components): create details row
3f66258
@gevann
docs(guides, components): wrap code-block example in quadruple back-t…
53daf20 
…icks
@gevann
docs(guides, components): create page-link entry
255654a
@gevann
docs(guide): add config entries for more doc pages
c38f20d 
Updates the scalar config's component documentation entries to include:
  - cards
  - details
  - page-links
  - rows
@gevann
docs(guides, components): add directive syntax to button
e4b47e1
@gevann
docs(guides, components): add directive syntax to callouts
3aa37f6
@gevann
docs(guides, components): add directive syntax to embeds
b06d139
@gevann
docs(guides, components): add directive syntax to images
b09ec02
@gevann
docs(guides, components): add directive syntax to math
69611b1
@gevann
docs(guides, components): add directive syntax to steps
a27fe6f
@gevann
docs(guides, components): add directive syntax to tabs
2a2370a
@gevann gevann force-pushed the graeme/doc-3725-add-documentation-for-all-components branch from 95ca3b4 to 2a2370a Compare July 22, 2025 16:07
marclave
marclave approved these changes Jul 23, 2025
View reviewed changes
Copy link
Member

@marclave marclave left a comment

Choose a reason for hiding this comment

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

AWESOME!!!

nice work @gevann

@marclave marclave merged commit 48f4b92 into main Jul 23, 2025
62 of 63 checks passed
@marclave marclave deleted the graeme/doc-3725-add-documentation-for-all-components branch July 23, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marclave marclave marclave approved these changes

@hanspagel hanspagel Awaiting requested review from hanspagel hanspagel is a code owner

@amritk amritk Awaiting requested review from amritk amritk is a code owner

@geoffgscott geoffgscott Awaiting requested review from geoffgscott geoffgscott is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gevann @marclave
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy