-
Notifications
You must be signed in to change notification settings - Fork 375
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
feat: render .md files from packages #2540
feat: render .md files from packages #2540
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2540 +/- ##
==========================================
- Coverage 60.15% 60.15% -0.01%
==========================================
Files 561 561
Lines 74999 74999
==========================================
- Hits 45117 45115 -2
- Misses 26505 26506 +1
- Partials 3377 3378 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
… into feat/md-renderer-package
Hey Alexis, thank you! Could you please share some before and after screenshots when making UX changes? We're hoping to have automatic deployment with @gfanton's upcoming refactor and @sw360cab's scripts. Until then, we'll need to manually share the changes to avoid requiring everyone to install and run the tool. |
Hey @moul 👋 Here is the current version (live version from gno.land) of a
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM for the result, but I don't have the skill to review the JS.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 🚀
<!-- please provide a detailed description of the changes made in this pull request. --> This PR aims to solves gnolang#2494 in order to parse `markdown` files from packages templates. It currently uses the file extension (from `window.location`) to detect if the content is a `md` file in a package template. _Although keeping the extension in the url is not a good practice for SEO & UX (because we are using pretty URLs for some other contents and are not consistent throughout gnoweb), This should do the work for now as short term solution since we are gonna parse `.md` from `go` soon with the new gnoweb design/codebase refactor (cc @gfanton)._ It also improves the package file template by removing global JS and pushing the `source` content into the main rendering flow from `renderer.js`.
This PR aims to solves #2494 in order to parse
markdown
files from packages templates. It currently uses the file extension (fromwindow.location
) to detect if the content is amd
file in a package template.Although keeping the extension in the url is not a good practice for SEO & UX (because we are using pretty URLs for some other contents and are not consistent throughout gnoweb), This should do the work for now as short term solution since we are gonna parse
.md
fromgo
soon with the new gnoweb design/codebase refactor (cc @gfanton).It also improves the package file template by removing global JS and pushing the
source
content into the main rendering flow fromrenderer.js
.