commit | ccefad5ad994c2b8fd91810f5bd265d585aa835f | [log] [tgz] |
---|---|---|
author | lvekee <61262208+lvekee@users.noreply.github.com> | Fri Apr 22 22:31:16 2022 +0800 |
committer | GitHub <noreply@github.com> | Fri Apr 22 22:31:16 2022 +0800 |
tree | 9dcc25d07fd66921919b7e9882107e97e9304148 | |
parent | 24d12b562d2fb290dabd3ae878a6412fe7bab629 [diff] |
Refactor the directory structure of the official website (#438) * refactor docs/zh-cn * update seo * refactor en-us * fix error in the metrics doc * fix * fix
All website material of https://seata.io
seata.github.io is powered by docsite.please read https://docsite.js.org If your version of docsite is less than 1.3.3
, please upgrade to 1.3.3
. Please also make sure your node version is 8.x, versions higher than 8.x is not supported by docsite yet.
npm install docsite -g
to install the dev tool.npm i
in the root directory to install the dependencies.docsite start
in the root directory to start a local server, you will see the website in ‘http://127.0.0.1:8080’.docsite build
to build source code.python -m SimpleHTTPServer 8000
, when your python version is 3 use :python3 -m http.server 8000
instead.If you have higher version of node installed, you may consider nvm
to allow different versions of node
coexisting on your machine.
nvm install v8.16.0
to install node v8nvm use v8.16.0
to switch the working environment to node v8npm install docsite -g
Make sure npm
and docsite
are configured in the environmet configuration of os . eg: /etc/profile or .bash_profile of Macos
Then you are all set to run and build the website. Follow the build instruction above for the details.
SEO
config is required.notice : Blog documents will be automatically sorted by time, without menu configuration
Set ‘hidden’ to ‘true’ for documents you don't want to display temporarily`
the type is :
--- hidden: false title: title keywords: keywords1,keywords2 description: some description author: author name date: 2018-12-29 ---
If you want to add search in site
,see https://docsite.js.org/zh-cn/docs/search.html
This is docsite docs :https://docsite.js.org/zh-cn/docs/path.html
If you want to update saga statemachine designer, rebuild it, see https://github.com/seata/seata/tree/develop/saga/seata-saga-statemachine-designer, and copy index.html
and dist/
directory to seata.github.io/saga_designer/
directory.