Skip to content
This repository was archived by the owner on Jul 10, 2023. It is now read-only.

Do not use node package for creating remark config any more -> so we can exclude check for proudct,#61

Merged
wipfli merged 1 commit intomaplibre:mainfrom
astridx:remark_config
Jul 3, 2021
Merged

Do not use node package for creating remark config any more -> so we can exclude check for proudct,#61
wipfli merged 1 commit intomaplibre:mainfrom
astridx:remark_config

Conversation

@astridx
Copy link
Copy Markdown
Contributor

@astridx astridx commented Jun 30, 2021

Because of the remark configuration we can not use Maplibre as product name . I stumbled across this in #58. It is not possible to use Maplibre GL JS in https://github.com/maplibre/maplibre-gl-js-docs/pull/58/files#diff-604664e92c63ab379a8bdf863252857482ffd1f642e3cdd4223985ad9ca8a705 as product name.

Thereby we would have the possibility to overwrite this via parameter.
Unfortunately, this ist not possible in our repositiory, if we use the package remark-config-docs for creating the configuration.

Therefore, I removed the package [remark-config-docs] (https://www.npmjs.com/package/@mapbox/remark-config-docs) and added the same configuration statically.

A static implementation is not the best, I know. But this way

  • we make Maplibre docs one package more independent.
  • We can change the static file more easily if we want to adapt other remark rules. (Later, we can build a solution that suits us.)
  • Now we can use our own product name.

What do you think?

@wipfli
Copy link
Copy Markdown
Contributor

wipfli commented Jun 30, 2021

Looks interesting.

And how can we make MapLibre GL JS a product with that?

Also, do we even care about the product in the markdown? I don't see this showing up anywhere on the docs website.

@astridx
Copy link
Copy Markdown
Contributor Author

astridx commented Jun 30, 2021

And how can we make MapLibre GL JS a product with that?

You can't add it. The line

disableProducts: true,

ensures that the product name is not checked.

disableProducts: false, activates the check

disableProducts: true,

Also, do we even care about the product in the markdown? I don't see this showing up anywhere on the docs website.

I think you are right. I can't see the product name on the page either. It just bothered me. That's why I searched where to change it.

@wipfli
Copy link
Copy Markdown
Contributor

wipfli commented Jul 1, 2021

Great, thanks for the clarification. I think even if this change will not show up in the frontend, it is still worth doing since we can remove Mapbox from the markdown in our examples. So thanks for the work and feel free to merge this in :)

Copy link
Copy Markdown
Contributor

@wipfli wipfli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@wipfli wipfli merged commit ea991e0 into maplibre:main Jul 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants