Skip to content

docs: add docs for file imports #368

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

Merged
merged 11 commits into from
Oct 14, 2024

Conversation

kevinzunigacuellar
Copy link
Contributor

Description

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! 🙌

This is good a start. For the #250 I think we want to have documentation for all supported markdown syntax. It should have links to Astro and expressive-code, and probably some small examples from each. Also the Callouts.

The structure could be something like:

// creating-content.mdx

## Markdown support
...

### Displaying code
<some examples showing how to select language for syntax highlight and highglight specific lines. Add links to asto & expressive-code.>

### Importing files
<the guide this pr already has>

### Callouts
<examples and description of callouts>

@Nemikolh & @sulco any thoughts?

@Nemikolh
Copy link
Member

@AriPerkkio, I agree with your proposed structure! Long term we could even have the # Markdown support section describes everything that's possible but right now if it shows the most commonly used things and link to expressive-code that would be a great start 🙌

@kevinzunigacuellar
Copy link
Contributor Author

Thanks for the review and clarification. I wasn't sure if I should write an entire markdown/mdx section so I decided to start with just file imports.

Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks @kevinzunigacuellar! 🙌

In future we can extend the examples to show more features provided by expressive-code and Astro, but for now it's good enough to provide links and that one example.

These changes will be automatically deployed when we release the next version of TutorialKit.

@AriPerkkio AriPerkkio merged commit bc01566 into stackblitz:main Oct 14, 2024
10 checks passed
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.

Add docs for supported markdown syntax
3 participants