-
Notifications
You must be signed in to change notification settings - Fork 138
feat(test-site): add tricky rendering cases for table, diagrams, plugins #2741
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
base: master
Are you sure you want to change the base?
Conversation
AgentHagu
left a comment
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.
Hi @arshinsikka, thanks for adding the new site. However, there are a few issues regarding the new site.
- Test sites should be added under
packages\cli\test\functionaland thetestSites.jsfile should be updated to include the new site - The test site you added doesn't seem to be a valid MarkBind site folder, remember to run
markbind initto set it up properly
You can refer to the developer guide for more details. Once the following issues are addressed, I can take a closer look at the test site content you've added.
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.
Good work exploring the different features of MarkBind and coming up with some sample syntax.
Some comments:
To test the site locally:
npx markbind serve packages/core/test/tricky-site
Running this on your branch, I get:
npx markbind serve packages/core/test/tricky-site
__ __ _ ____ _ _
| \/ | __ _ _ __ | | __ | __ ) (_) _ __ __| |
| |\/| | / _` | | '__| | |/ / | _ \ | | | '_ \ / _` |
| | | | | (_| | | | | < | |_) | | | | | | | | (_| |
|_| |_| \__,_| |_| |_|\_\ |____/ |_| |_| |_| \__,_|
v6.0.2
error: Config file not found at user specified root C:\......\markbind\packages\core\test\tricky-site
error: This directory does not appear to contain a valid MarkBind site. Check that you are running the command in the correct directory!
Edit, noticed your path is missing unit as well, i.e. packages\core\test\unit\tricky-site.
As per @AgentHagu ^ on this.
Additionally, I am not sure if you are aware / have done so, but try loading the test jumbotron by doing, :
markbind serve packages\cli\test\functional\test_site
There are some existing functional testcases such as plantuml diagrams, mermaid diagrams, auto-anchors which this PR seeks to add that you can take a look at!
Additionally, I think you could reconsider if these added sites fall under the scope of unit tests. Perhaps it could be more effective and helpful to implement any additional tricky rendering cases as automated tests that catch for regressions as well.
While considering these aspects, if you have any suggestions to make the testing more modular, simpler, easier to understand, more documentation, do feel free to check out existing issues, comment on them your findings, or open a unique issue!
ba96582 to
5920bfa
Compare
5920bfa to
75def32
Compare
|
Update |
|
Hi @arshinsikka thanks for continuing the dev effort! We appreciate new devs working on this project! However, I couldn't see the changes you mentioned reflected in the PR |
What is the purpose of this pull request?
Overview of changes:
packages/core/test/tricky-site/.mdpages for testing rendering of:<table>elements with/without<tbody><mermaid>flowchart rendering<puml>plugin rendering (inline, named, and external)<span heading>➝<span slot="header" ...>)<tree>plugin rendering directory-like structuresindex.mdfor navigation and a complete_site.jsonAnything you'd like to highlight/discuss:
render-corner-cases) or placed under a different path.Testing instructions:
To test the site locally:
npx markbind serve packages/core/test/tricky-site
Navigate to each page and confirm that the rendering reflects expectations.
Proposed commit message: (wrap lines at 72 characters)
feat(test-site): add tricky rendering cases for table, diagrams, plugins
Adds a reusable test site under packages/core/test/tricky-site
to visualize rendering of tricky or previously buggy scenarios.
Includes pages for
<table>,<mermaid>,<puml>, shorthand syntax,tree plugin, and auto-anchors. Helps contributors manually test
and verify rendering behavior when working on plugins or layout.
Checklist: ☑️
Reviewer checklist:
Indicate the [SEMVER](https://semver.org/) impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):
Not applicable