Skip to content

Conversation

@indranildeveloper
Copy link
Contributor

@indranildeveloper indranildeveloper commented Aug 19, 2025

Create new Documentation using Docusaurus

In this Pull Request I have created a new docusaurus project called website-docusaurus.

Here are some initial screenshots:

Screenshot_20250901_162458 Screenshot_20250901_162548

To run the new docs locally you can run this command:

yarn start:website-secondary

What is done:

  1. Creation of the docusaurus project.
  2. Identify and resolve all the {} brackets that were causing errors.
  3. Full latex support for the mathematical expressions.
  4. Created the welcome page.
  5. Rearrange the markdown files so that it follow the current documentation.
  6. Update the documentation page titles and names.

What needs to be done:

  1. The home page.

@indranildeveloper indranildeveloper marked this pull request as draft August 19, 2025 09:48
@indranildeveloper
Copy link
Contributor Author

@ibgreen @igorDykhta @lixun910 @heshan0131 Please have a look and share your feedback.

@igorDykhta igorDykhta self-requested a review August 19, 2025 10:17
@igorDykhta igorDykhta added the docs Documentation only changes and request label Aug 19, 2025
@lixun910
Copy link
Collaborator

Great effort, thanks @indranildeveloper !! I think you can migrate the default webiste of kepler.gl (https://github.com/keplergl/kepler.gl/tree/master/website) to docusauraus default page, so both the kepler.gl website and docs can be maintained here.

@chrisgervang
Copy link
Collaborator

Might be a good idea to bring in the heading ID utility we have in vis.gl docusaurus template: https://github.com/visgl/dev-tools/blob/master/modules/docusaurus-website/src/write-heading-ids.ts (along with its tests), or for us to publish this as a small package for you to use. docusaurus is great, but as the examples show the header links are problematic.

It's great to see an effort to use docusaurus with kepler. I'd suggest keeping it separate from the main website until all (or most) of the content is ported over. Please remove the "tutorial" and placeholder graphics before merging.

The actual home page should be straightforward to port over since its also made with react.

For the OpenJS copyright and foundation logo you can copy what I've done here: visgl/dev-tools#13

@indranildeveloper
Copy link
Contributor Author

Thanks @chrisgervang, I will implement these things.

@ibgreen
Copy link
Collaborator

ibgreen commented Aug 26, 2025

Two pieces of advice: Avoid breaking current site setup, and find a way to stage the new website.

In a few places you modify the existing markdown docs in a way that presumably breaks the existing website (ToC etc).

If that could be avoided (perhaps by copying a few files), your entire docusaurus setup PR could be landed as a "secondary website" directory, without anyone having to take a big decision.

I think it would be very helpful if you could stage the new website.

I believe that we typically do this by publishing the docusaurus website in the github pages of your kepler.gl fork repository (placing a blocking robots.txt file in the root of published website to prevent crawlers from being confused).

The amount of "eyes" you would get on your new website would be 10x if you could share a link to a staged website, compared to asking people to build it themselves.

@ibgreen
Copy link
Collaborator

ibgreen commented Aug 26, 2025

Also the initial screenshot is the default docusaurus screenshot. I strongly recommend fixing that before staging / sharing widely, it is a small thing but gives the wrong initial impression to viewers regarding the completeness of this effort.

Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Signed-off-by: Indranil Halder <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation only changes and request post-3.2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants