Navigate back to the homepage

Docusaurus

Teik Jun
September 14th, 2020 · 1 min read

I’ve been contributing to open-source at Docusaurus for a while now, and it has been an awesome learning journey. Docusaurus is a static site generator that is tailored for documentation sites. As we know, documentation is a developer’s best friend, so it is important to have readable documentation sites. Docusaurus is basically an npm package that generates a site fully equipped with documentation features out of the box. Users can proceed to customize it.

Docusaurus uses a modern technology stack - React, Typescript, Jest, Babel, Webpack, and so on. It is even using modern devops tools like Yarn workspaces. It was really nice to see how they made use of modern technologies and learn from it.

At the moment, I’m among the top 20 contributors of Docusaurus and rising. I’ve mostly worked on bug fixes and new features. One cool feature that I worked on was validating user’s configuration for Docusaurus plugins, so that incorrect configuration by users will fail fast and send a warning to the user. Currently, I’m working on a migration tool to migrate Docusaurus v1 site automatically to v2.

I’m very grateful to the maintainers of Docusaurus, Yangshun and Sebastian, for guiding me as I contribute to Docusaurus. I’m going to continue to build new features and improve Docusaurus.

More articles from Teik Jun

NUSMODS

Contributing to open source at NUSMODS

September 10th, 2020 · 1 min read

Teammates

Project maintainer at TEAMMATES

August 6th, 2020 · 1 min read
© 2020 Teik Jun
Link to $https://twitter.com/teik_junLink to $https://github.com/teikjunLink to $https://www.linkedin.com/in/tan-teik-jun-0976b1152/Link to $https://stackoverflow.com/users/11537371/teik-jun