Upgrade website and documentation to Docusaurus #187
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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.
…dle inline {@link } tags very well.
…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.
…HS nav bar more sensible.
…ifferent Turf functions. Fixing some footer links.
…ix - probably don't need it for generating documentation?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.