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

docsite: Add syntax coloring #314

Merged
merged 3 commits into from
Mar 28, 2024
Merged

docsite: Add syntax coloring #314

merged 3 commits into from
Mar 28, 2024

Conversation

juliaogris
Copy link
Member

@juliaogris juliaogris commented Mar 27, 2024

Add syntax coloring to docsite. This PR required factoring out all syntax
coloring related bits from the playground CSS and module/editor.js.


https://evy-lang-stage-docs--314-elz1ivtw.web.app/syntax_by_example.html

Factor out evy syntax highlighting for reuse in docs. Initially we will not
use an editor in the docs so all we need to do is replace the <pre><code>
codeblocks with the highlighted content.
Add syntax coloring to docsite now that we have factored it out of the
playground. This requires that we replace ```evy:out and ```evy:err and
```evy:in tags with valid CSS classnames: `evy-out`, `evy-err` and `evy-in`
in build-tools/md.

Additionally we need to use the query selector `language-evy` to select all
evy code blocks, because rsc.io/markdown doesn't allow us to override the
classname used for codeblocks and reimplementing markdown.CodeBlock.PrintHTML
is not possible without copying big blocks of code - so we have to work with
the classname `language-evy` and `language-evy-out` for the time being.

We also need to link highlight.js and syntax.css with with the docs site and
update the the template in build-tools/md. docs/index.js has a little addition
of applying highlightEvy to all its code blocks.

Commit-group: 1/2
Add syntax coloring to docsite now that we have factored it out of the
playground. This requires that we replace ```evy:out and ```evy:err and
```evy:in tags with valid CSS classnames: `evy-out`, `evy-err` and `evy-in`
in build-tools/md.

Additionally we need to use the query selector `language-evy` to select all
evy code blocks, because rsc.io/markdown doesn't allow us to override the
classname used for codeblocks and reimplementing markdown.CodeBlock.PrintHTML
is not possible without copying big blocks of code - so we have to work with
the classname `language-evy` and `language-evy-out` for the time being.

We also need to link highlight.js and syntax.css with with the docs site and
update the the template in build-tools/md. docs/index.js has a little addition
of applying highlightEvy to all its code blocks.

Gen-command: make docs && make snaps USE_DOCKER=1
Commit-group: 2/2
Copy link
Member

@camh- camh- left a comment

Choose a reason for hiding this comment

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

📗

@juliaogris juliaogris merged commit 0bdee03 into main Mar 28, 2024
3 checks passed
@juliaogris juliaogris deleted the syntax-coloring branch March 28, 2024 02:20
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