Skip to content

docs: add SCSS, Less and Stylus language pages#999

Open
Posterfo wants to merge 1 commit into
live-codes:developfrom
Posterfo:docs/css-preprocessor-langs
Open

docs: add SCSS, Less and Stylus language pages#999
Posterfo wants to merge 1 commit into
live-codes:developfrom
Posterfo:docs/css-preprocessor-langs

Conversation

@Posterfo

@Posterfo Posterfo commented Jun 23, 2026

Copy link
Copy Markdown

What type of PR is this? (check all applicable)

  • ✨ Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • ♻️ Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert
  • 🌐 Internationalization / Translation

Description

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentations?

  • 📓 docs (./docs)
  • 📕 storybook (./storybook)
  • 📜 README.md
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Summary by CodeRabbit

  • Documentation
    • Expanded documentation for Less, SCSS, and Stylus CSS preprocessors with complete coverage including interactive live code examples, usage and syntax guidance, external stylesheet importing methods, compiler configuration details, code formatting recommendations, and comprehensive links to official resources and related guides.

@netlify

netlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Deploy Preview for livecodes ready!

Name Link
🔨 Latest commit 9261ff0
🔍 Latest deploy log https://app.netlify.com/projects/livecodes/deploys/6a3aab248749d600083aa944
😎 Deploy Preview https://deploy-preview-999--livecodes.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@sonarqubecloud

Copy link
Copy Markdown

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Three CSS preprocessor language documentation pages (less.mdx, scss.mdx, stylus.mdx) are converted from TODO... placeholders into complete MDX documentation. Each page adds a LiveCodes import, an exported demo config object, and structured sections covering usage, external style loading, language metadata, compiler details, code formatting, and reference links.

Changes

CSS Preprocessor Language Documentation

Layer / File(s) Summary
Less language documentation
docs/docs/languages/less.mdx
Replaces placeholder with full Less docs: exports lessConfig demo, adds Usage, @import loading, Language Info, Less.js compiler with custom settings JSON, Prettier formatting guidance, and links.
SCSS language documentation
docs/docs/languages/scss.mdx
Replaces placeholder with full SCSS docs: exports scssConfig demo, adds Usage, Loading External Styles subsections (@use, @import, meta.load-css()), Language Info, Dart Sass compiler with custom settings, Prettier guidance, and links.
Stylus language documentation
docs/docs/languages/stylus.mdx
Replaces placeholder with full Stylus docs: exports stylusConfig demo, adds Usage, @import loading, Language Info, in-browser stylus npm package compiler, notes no Prettier support, and links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • live-codes/livecodes#946: Same pattern of converting a CSS language MDX placeholder into a full docs page with an exported *Config demo object and <LiveCodes config={...} /> render.
  • live-codes/livecodes#954: Same documentation-only MDX pattern adding LiveCodes imports and exported *Config objects to language pages under docs/docs/languages/.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding documentation pages for three CSS preprocessor languages (SCSS, Less, and Stylus).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes — 3 new language documentation pages for Less, SCSS, and Stylus, replacing TODO... placeholders with complete content following the existing sass.mdx template.

  • New less.mdx page — covers Less syntax, @import for external styles, Less.js compiler, custom settings via the less config property, and Prettier formatting.
  • New scss.mdx page — covers SCSS syntax, @use/@import/meta.load-css() for external styles, Dart Sass compiler, custom settings via the scss config property, Prettier formatting, and a cross-link to sass.mdx.
  • New stylus.mdx page — covers Stylus flexible syntax, @import for external styles, Stylus compiler, notes that Prettier code formatting is not available for Stylus.

Pullfrog  | View workflow run | Using DeepSeek Pro (free via Pullfrog for OSS) | 𝕏

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/docs/languages/scss.mdx`:
- Around line 119-120: The meta.load-css() example URL uses an incorrect GitHub
raw content path format with /refs/heads/develop/ which will fail when users
execute the code snippet. Fix the URL by replacing the /refs/heads/develop/
segment with the correct raw content format where develop is the branch name in
the standard raw.githubusercontent.com path structure. The corrected URL should
point directly to the raw file content on the develop branch without the
/refs/heads/ intermediary path.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: ee97d148-facd-436d-821f-c9c193a854ed

📥 Commits

Reviewing files that changed from the base of the PR and between 1d722a9 and 9261ff0.

📒 Files selected for processing (3)
  • docs/docs/languages/less.mdx
  • docs/docs/languages/scss.mdx
  • docs/docs/languages/stylus.mdx

Comment on lines +119 to +120
'https://raw.githubusercontent.com/live-codes/livecodes/refs/heads/develop/src/livecodes/styles/app.scss'
);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fix the meta.load-css() example URL format.

At Line 119, the raw GitHub URL uses /refs/heads/develop/, which is not the direct raw-content path format and will likely fail when users try the snippet.

Proposed fix
 `@include` meta.load-css(
-  'https://raw.githubusercontent.com/live-codes/livecodes/refs/heads/develop/src/livecodes/styles/app.scss'
+  'https://raw.githubusercontent.com/live-codes/livecodes/develop/src/livecodes/styles/app.scss'
 );
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
'https://raw.githubusercontent.com/live-codes/livecodes/refs/heads/develop/src/livecodes/styles/app.scss'
);
`@include` meta.load-css(
'https://raw.githubusercontent.com/live-codes/livecodes/develop/src/livecodes/styles/app.scss'
);
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/docs/languages/scss.mdx` around lines 119 - 120, The meta.load-css()
example URL uses an incorrect GitHub raw content path format with
/refs/heads/develop/ which will fail when users execute the code snippet. Fix
the URL by replacing the /refs/heads/develop/ segment with the correct raw
content format where develop is the branch name in the standard
raw.githubusercontent.com path structure. The corrected URL should point
directly to the raw file content on the develop branch without the /refs/heads/
intermediary path.

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.

1 participant