Skip to content

Conversation

edmundmiller
Copy link
Member

Summary

Restructure pipeline examples from flat files to organized subdirectories under /examples/, with colocated docs and code files.

Changes

  • Move examples.astro → examples/index.astro
  • Create subdirs: basic-pipeline/, blast-pipeline/, rna-seq-pipeline/, machine-learning-pipeline/, mixing-scripting-languages/
  • Extract embedded code from .md to separate _main.nf files
  • Convert .md to .mdx with Expressive Code imports
  • Clean URLs without trailing slashes (/examples/basic-pipeline)
  • Update navigation and fix active page highlighting
  • Add backward compatibility redirects

Dependencies

⚠️ Stacked PR: Merge after #423

Better organization, consistent patterns, maintainable structure.

- Configure comprehensive style overrides to match site's clean, minimal aesthetic
- Use pure white backgrounds and site's CSS variables (--nextflow-green colors)
- Set proper text marker highlighting with site's light green accent color
- Remove frame titles and switch to 'nextflow' language for syntax highlighting
- Maintain advanced highlighting functionality while achieving visual integration
- Result: Code blocks now blend seamlessly with site design while providing enhanced educational features

The example pages now have clean, professional code blocks that match the site's
design system perfectly, with clearly visible line highlighting using the site's
signature green color scheme.
Copy link

netlify bot commented Sep 21, 2025

Deploy Preview for nextflow-staging ready!

Name Link
🔨 Latest commit fa5ae6c
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-staging/deploys/68cfc2539af2100008f38caf
😎 Deploy Preview https://deploy-preview-424--nextflow-staging.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: 69 (🟢 up 11 from production)
Accessibility: 74 (no change from production)
Best Practices: 83 (no change from production)
SEO: 88 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

edmundmiller and others added 3 commits September 21, 2025 11:13
- Create separate ec.config.mjs for Expressive Code plugin configuration
- Install @expressive-code/plugin-line-numbers plugin
- Enable line numbers by default with showLineNumbers: true
- Set optimal font size (1.5rem/24px) for better code readability
- Simplify astro.config.mjs to use basic expressiveCode() integration
- Maintain all existing styling and text marker functionality
- Fix MDX Code component compatibility with plugin-based configuration
- Support external file imports with ?raw suffix for clean separation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Restructure pipeline examples from flat files to organized subdirectories 
under /examples/, with colocated docs and code files.

- Move examples.astro → examples/index.astro  
- Create subdirs: basic-pipeline/, blast-pipeline/, rna-seq-pipeline/, 
  machine-learning-pipeline/, mixing-scripting-languages/
- Extract embedded Nextflow code from .md to separate main.nf files
- Convert .md to .mdx with Expressive Code imports
- Clean URLs without trailing slashes (/examples/basic-pipeline)
- Update all navigation and links to new structure
- Fix active page highlighting in side navigation
- Add backward compatibility redirects

Better organization, consistent patterns, maintainable structure.
Rename all main.nf files to _main.nf and update corresponding import 
statements to prevent Astro from treating pipeline files as pages.

- Rename: main.nf → _main.nf in all pipeline subdirectories
- Update imports: './main.nf?raw' → './_main.nf?raw' in all .mdx files
- Eliminates console warnings about unsupported file types
- Maintains functionality while following Astro conventions
@edmundmiller edmundmiller force-pushed the examples-directory-reorganization branch from 2165de4 to fa5ae6c Compare September 21, 2025 09:16
@edmundmiller edmundmiller self-assigned this Sep 21, 2025
@mavi-sqr
Copy link
Collaborator

mavi-sqr commented Sep 23, 2025

Hi @edmundmiller
Thanks for tagging us here.

  1. If you go to Machine learning example, the layout has been regressed. The content is not responsive.
    examples
Captura de pantalla 2025-09-23 a las 12 20 03
  1. Also, should we style the commands somehow to highlight them among all the content?
Captura de pantalla 2025-09-23 a las 12 20 18

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