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

Cadl Website #935

Merged
merged 94 commits into from Aug 29, 2022
Merged

Cadl Website #935

merged 94 commits into from Aug 29, 2022

Conversation

timotheeguerin
Copy link
Member

@timotheeguerin timotheeguerin commented Aug 28, 2022

cleanup and improvement over the initial website implementation in #875.
Cleanup UI pieces that we don't need(at least for now).

  • Tweak the colors a little.
  • Setup docs navigation
  • Setup syntax highlighting for code snippet
    • Including cadl: Better than github docs now!
  • Publish to storage account

image

@azure-pipelines
Copy link

azure-pipelines bot commented Aug 28, 2022

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/935/

Check the website changes at https://cadlwebsite.z1.web.core.windows.net/prs/935/

operator:
/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/,
punctuation: /[{}[\];(),.:]/,
};
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we can use the tmlanguage somehow? Seems annoying to have another set of regexes to maintain.

Copy link
Member Author

Choose a reason for hiding this comment

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

Haha, yeah..., I did look if there was an existing way to auto convert it but doesn't seem like there is. Felt more work to get this to work.

Copy link
Contributor

Choose a reason for hiding this comment

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

More work for sure, but I imagine we could convert to html as bicep does for its tests: https://github.com/Azure/bicep/blob/main/src/textmate/test/baselines/comments.html

And do that on publish?

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe file an issue?

Copy link
Member Author

Choose a reason for hiding this comment

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

oh you mean we are the one doing the syntax highlighting instead of using the extension(via PrismJs)

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe? Just brainstorming here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Created an issue #938

This was the PR that added bicep to PrismJS, where they seemed to have manually intepreted the tmlanguage and wrong a simple primsjs language
PrismJS/prism#3027

@timotheeguerin timotheeguerin merged commit 057c124 into microsoft:main Aug 29, 2022
@timotheeguerin timotheeguerin deleted the cadl-website branch August 29, 2022 16:52
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.

None yet

4 participants