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

Upgrade website and documentation to Docusaurus #187

Merged
merged 21 commits into from
May 31, 2024

Conversation

smallsaucepan
Copy link
Member

@smallsaucepan smallsaucepan commented May 3, 2024

PR to upgrade Turf website and documentation to use Docusaurus, a markdown based platform used by many open source projects e.g. React Native, Jest. IMO will make updates to documentation, multiple doc versions, etc easier to understand and perform. New home page demo map also feels pretty neat.

PR largely replaces the old website files, though keeps a few legacy directories like logos, etc. Being a new framework there isn't a lot of overlap.

General documentation generation approach goes from source (link to turfjs/turf repo) -> documentation.js -> custom script to mdx -> checked in to git in docs/api/ folder. Other elements of the old website (README and CONTRIBUTING) have been merged over.

Currently deployed as a test site to github pages at https://turfjs.smallsaucepan.com

Once the basic site is deployed successfully, can develop PRs to incorporate searching and any other additions.

Also resolves #175 and resolves #186.

…site. Kept only minimal overlapping files to avoid cruft removal later. Will port existing components, scripts and pages into docusaurus setup in subsequent commits.
…r most 6.5.0 single function packages. Need to update for packages like helpers and meta that contain multiple exported functions. Includes component to display maps derived from jsdoc @example tags.
…urce returns information from a different section of the documentation.js output that separates out embedded links.
…ing generated typescript and MDX to improve visibility of any manual tweaks we need to make post versioning.
…ing a production site for deployment. Our old friend "rbush is not a constructor" was not playing well with server side generation. Seems to work ok in the browser though.
…nerate docs for. Mainly malformed JSDoc in the 6.5.0 source.
…on was showing up under map in API webpages.
…er <Map /> line, so adding a prettier ignore line above it. Removing a couple of packages that weren't documented or exported in @turf/turf 6.5.0. They're not in the CDN version that the website uses, so will reintroduce them once v7 is on the CDN instead.
…er <Map /> line, so adding a prettier ignore line above it. Removing a couple of packages that weren't documented or exported in @turf/turf 6.5.0. They're not in the CDN version that the website uses, so will reintroduce them once v7 is on the CDN instead.
…ifferent Turf functions. Fixing some footer links.
@smallsaucepan smallsaucepan merged commit df38d45 into Turfjs:master May 31, 2024
1 check 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.

Error with map not showing Browser history is not working
1 participant