This project keeps all sources used for building up InLong official website which's served at https://inlong.apache.org/
InLong website is powered by Docusaurus.
If your version of Docusaurus is less than 2.0.0
,please upgrade to 2.0.0
.
Please also make sure your node version is 16.14.x, versions higher than 16.14.x is not supported by Docusaurus yet.
npm i
in the root directory to install the dependencies.npm start
in the root directory to start a local server, you will see the website in 'http://127.0.0.1:3000'.npm run build
to build source code.If you need to see the documentation in simplified Chinese, first npm run build
, then use npm run start-zh
.
If you have higher version of node installed, you may consider nvm
to allow different versions of node
coexisting on your machine.
nvm install v16.14.0
to install node v16nvm use v16.14.0
to switch the working environment to node v16Then you are all set to run and build the website. Follow the build instruction above for the details.
Make sure you have submit issue for tracking PR: https://github.com/apache/inlong/issues
git add .
to commit all the changes.*.md
docs
or i18n
.docs
, then run npm run docusaurus docs:version replace_by_target_version
locally to copy a document.docusaurus.config.js
file./src/pages/version/index.js
.