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

markdown infrastructure refactor #1302

Closed
6 tasks done
samuelstroschein opened this issue Aug 29, 2023 · 4 comments · Fixed by #1357
Closed
6 tasks done

markdown infrastructure refactor #1302

samuelstroschein opened this issue Aug 29, 2023 · 4 comments · Fixed by #1357
Assignees
Labels
scope: website Related to source-code/website, excluding editor related code. type: documentation Improvements or additions to documentation type: refactor Code being refactored to improved performance or long-term maintainability.

Comments

@samuelstroschein
Copy link
Member

samuelstroschein commented Aug 29, 2023

Tasks

  • replace markdoc vs commonmark or similar markdown renderer to increase interop
  • table of contents should include "startpage" instead of hardcoded href to remove href
  • use slug instead of href to minimize risks of broken links
  • use web components with lit.dev to increase interop and reduce maintenance effort
  • derive the title from # instead of frontmatter for interop with github and less explanation required
  • [bug] inlang documentation site doesn't load if wasm is disabled #1321
@samuelstroschein samuelstroschein self-assigned this Aug 29, 2023
@maige-app maige-app bot added type: refactor Code being refactored to improved performance or long-term maintainability. scope: inlang/sdk Related to source-code/sdk. labels Aug 29, 2023
@flornkm flornkm assigned flornkm and unassigned samuelstroschein Sep 11, 2023
@flornkm flornkm added type: documentation Improvements or additions to documentation scope: website Related to source-code/website, excluding editor related code. and removed scope: inlang/sdk Related to source-code/sdk. labels Sep 11, 2023
@flornkm flornkm linked a pull request Sep 15, 2023 that will close this issue
@flornkm
Copy link
Contributor

flornkm commented Sep 20, 2023

@inlang/docs @samuelstroschein Loom update: https://www.loom.com/share/445129eabba04843b7ffa339b8d85a9e

Hopefully I get this done tomorrow!!! The GFM bug is extremely annoying, I can't really get back to the point were it worked.

Last tasks before release:

@flornkm
Copy link
Contributor

flornkm commented Sep 20, 2023

btw. sanitization is working through perfectly, it is no nice that we can white label not only custom elements but also their attributes!

@samuelstroschein
Copy link
Member Author

goob job @floriandwt! i commented on the loom

@flornkm
Copy link
Contributor

flornkm commented Sep 20, 2023

Thanks to @samuelstroschein the annoying issue has gone away 😁

Screenshot 2023-09-20 at 11 19 29 PM

such a bad timing, what a coincidence!! Look at the release of the new version of the plugin, haven't considered that to be a realistic case from where the bug could appear (because it worked on Friday :D):
Screenshot 2023-09-20 at 11 20 47 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: website Related to source-code/website, excluding editor related code. type: documentation Improvements or additions to documentation type: refactor Code being refactored to improved performance or long-term maintainability.
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants