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

refactor: markdown #1357

Merged
merged 95 commits into from
Sep 26, 2023
Merged

refactor: markdown #1357

merged 95 commits into from
Sep 26, 2023

Conversation

flornkm
Copy link
Contributor

@flornkm flornkm commented Sep 15, 2023

This PR introduces a new markdown rendering enabling more interop. between e.g. GitHub Readmes, Marketplace documentations, and can be used in further use cases. See #1302

@flornkm flornkm linked an issue Sep 15, 2023 that may be closed by this pull request
6 tasks
@changeset-bot
Copy link

changeset-bot bot commented Sep 15, 2023

⚠️ No Changeset found

Latest commit: 57b0900

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@samuelstroschein
Copy link
Member

@floriandwt can you copy the pacakge-lock.json fom the main branch, delete the package-lock.json in this branch, and run npm run ci afterwards?

the lock file got overwritten or something leading to "15.000 line of change"

Copy link
Member

@samuelstroschein samuelstroschein left a comment

Choose a reason for hiding this comment

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

Overall as expected. One remark:

The mermaid feature seems to introduce a lot (too much) complexity. I assume that you felt at one point "hm, adding a playwright dependency doesn't seem right". Speak up and discuss with your team members. Your gut feeling is usually right. The engineering goal is not to support any feature but to support a feature that is worth it given the compexity it introduces. Otherwise, the project will suffer from unreasonable long term maintainence burden(s).

inlang/documentation/reference/tableOfContents.md Outdated Show resolved Hide resolved
inlang/source-code/markdown/package.json Outdated Show resolved Hide resolved
inlang/source-code/website/package.json Outdated Show resolved Hide resolved
inlang/source-code/website/package.json Outdated Show resolved Hide resolved
inlang/source-code/website/package.json Outdated Show resolved Hide resolved
@flornkm
Copy link
Contributor Author

flornkm commented Sep 23, 2023

@samuelstroschein almost all remaining should be solved now, I will finish getting rid of mermaid on Monday and move the new tableOfContents function to the client then.

Edit: + introduce Gallery, but this is a smaller task anyway.

@flornkm flornkm merged commit abbf773 into main Sep 26, 2023
@flornkm flornkm deleted the markdown-refactor branch September 26, 2023 09:08
@github-actions github-actions bot locked and limited conversation to collaborators Sep 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: refactor Code being refactored to improved performance or long-term maintainability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

markdown infrastructure refactor
2 participants