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

Add "R" or "Remeda" globally to the docs website for easy experiments #661

Open
illiaChaban opened this issue May 1, 2024 · 4 comments · May be fixed by #671
Open

Add "R" or "Remeda" globally to the docs website for easy experiments #661

illiaChaban opened this issue May 1, 2024 · 4 comments · May be fixed by #671
Labels
docs Related to the documentation and the site feature request New feature or request good first issue Good for newcomers

Comments

@illiaChaban
Copy link

illiaChaban commented May 1, 2024

When you go to lodash docs, you can open dev tools > console, type "_" and access all lodash methods. This helps with trying things out and expeirmenting.
It would be nice if Remeda docs had the same feature

@eranhirsch eranhirsch added feature request New feature or request docs Related to the documentation and the site labels May 1, 2024
@eranhirsch
Copy link
Collaborator

Sounds like a cool idea

@cjquines cjquines added the good first issue Good for newcomers label May 1, 2024
@eranhirsch
Copy link
Collaborator

I'm not sure this is a good first issue, I don't have a good idea how this is achievable

@cjquines
Copy link
Collaborator

cjquines commented May 1, 2024

let me outline what i think the steps are

<script type="module">
  import * as R from "remeda";
  window.R = R;
</script>
  • check to see if it works (it should according to astro docs)
  • (potentially) change the package.json in docs to include remeda from the top-level directory so the version's always updated

i'll be happy to help anyone who runs into snags

@eranhirsch
Copy link
Collaborator

It looks cool. I don't want the docs project to import outside of NPM because it creates a lot of weird stuff when using Remeda as a utility library in the docs site. We can work around this by bumping the dependency in the docs package.json every time we publish a version of Remeda using another step in the Github workflow that releases it.

@clemgbld clemgbld linked a pull request May 5, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the documentation and the site feature request New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants