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

Provide examples for the wikify widget #8792

Conversation

DesignThinkerer
Copy link
Contributor

This PR add examples for using the wikify widget. Discussion: https://talk.tiddlywiki.org/t/doc-wikifywidget-examples-usecase/5890


Submitted using https://saqimtiaz.github.io/tw5-docs-pr-maker/.

Copy link

github-actions bot commented Dec 2, 2024

@DesignThinkerer It appears that this is your first contribution to the project, welcome.

With apologies for the bureaucracy, please could you prepare a separate PR to the 'tiddlywiki-com' branch with your signature for the Contributor License Agreement (see contributing.md).

Copy link

netlify bot commented Dec 2, 2024

Deploy Preview for tiddlywiki-previews ready!

Name Link
🔨 Latest commit b10ec93
🔍 Latest deploy log https://app.netlify.com/sites/tiddlywiki-previews/deploys/674f70b10d458b000887401a
😎 Deploy Preview https://deploy-preview-8792--tiddlywiki-previews.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pmario
Copy link
Member

pmario commented Dec 2, 2024

I think the first example should be something that works. It is OK to show how we should not do it, but it needs much more explanation, what we want to show.

If the first example is a fail users think it is broken. If we want to show "failed examples" it needs a detailed description, what's going on.

@pmario
Copy link
Member

pmario commented Dec 2, 2024

I also think, the example Output code should be more readable. Something similar to this.

image

@DesignThinkerer
Copy link
Contributor Author

I also think, the example Output code should be more readable. Something similar to this.

image

Thanks for the review. I applied your suggestions :)

@pmario
Copy link
Member

pmario commented Dec 2, 2024

I think it looks more readable now. But the https://deploy-preview-8792--tiddlywiki-previews.netlify.app/#TestCases%2FWikifyWidget%2FWidgetValue%2FSuccess fails.

You need to remove the very last new-line in the file - then it works

title: ExpectedResult

<p>
    <span style="color:white;background:purple;">
        white text on purple is a good contrast
    </span>
</p>    <- The line break here needs to be removed

@DesignThinkerer
Copy link
Contributor Author

DesignThinkerer commented Dec 2, 2024

@pmario good catch, it is now fixed :) (edit: there was another testcase with a trailing line, I fixed it)

image

Copy link

github-actions bot commented Dec 5, 2024

DesignThinkerer has signed the Contributor License Agreement (see contributing.md)

@Jermolene
Copy link
Member

Great stuff, thank you @DesignThinkerer

@Jermolene Jermolene merged commit 106fe2d into TiddlyWiki:tiddlywiki-com Dec 5, 2024
7 checks passed
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.

4 participants