Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 1.26 KB

README.md

File metadata and controls

22 lines (13 loc) · 1.26 KB

Introduction

This project is the new official documentation site for rocketmq. This website is built using Docusaurus 2, a modern static website generator.

For all of you who contribute documents, here are a few things to keep in mind:

  1. For the person responsible for writing the documentation, the only thing you need to modify is the content under ‘/docs’. Find the document you are responsible for under ‘/docs’ and write it in markdown. The rest of the site is automatic, so please do not modify it.

  2. For those who do translations, we are currently placing English documents at ‘/docs/09-English’ for the time being due to the error-prone nature of the multilingual version of the site.

  3. The framework we currently use supports some nice markdown features, please refer to it and try to speak about the beautiful writing of the document.Markdown Features

For those of you who have contributed documentation and wish to see the results after writing, please refer to the following command.

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.