Skip to content

microsoft/docusaurus-plugins

Repository files navigation

Rise4fun Docusaurus plugins

This repository contains plugins for Docusaurus to support creating rich documentation for programming languages tools.

Development

Install Volta, if you haven't got it installed already.

Once installed, Volta will automatically install the correct version of Node.js and Yarn for this project - no need to install them manually.

Install dependencies,

yarn install

To build plugins and final web site,

yarn build

To run a local development server,

yarn start

To create releases, use the semantic release commit syntax

  • feat: ... for a minor version bump
  • fix: ... for a patch version bump

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.