{"id":17972326,"url":"https://github.com/apache/incubator-seata-website","last_synced_at":"2025-04-04T16:12:34.679Z","repository":{"id":37493186,"uuid":"166406141","full_name":"apache/incubator-seata-website","owner":"apache","description":"Apache Seata(incubating) Website","archived":false,"fork":false,"pushed_at":"2025-03-30T12:11:43.000Z","size":723100,"stargazers_count":99,"open_issues_count":29,"forks_count":124,"subscribers_count":23,"default_branch":"docusaurus","last_synced_at":"2025-03-30T13:22:39.092Z","etag":null,"topics":["article","distributed-transaction","docsite","seata-website"],"latest_commit_sha":null,"homepage":"https://seata.apache.org/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security/secret-key.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-18T13:04:50.000Z","updated_at":"2025-03-28T12:04:08.000Z","dependencies_parsed_at":"2023-10-15T02:01:54.844Z","dependency_job_id":"9c5975a0-5756-4ff6-bdd5-6527ae6275be","html_url":"https://github.com/apache/incubator-seata-website","commit_stats":null,"previous_names":["apache/incubator-seata-website","seata/seata.github.io"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fincubator-seata-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fincubator-seata-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fincubator-seata-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fincubator-seata-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/incubator-seata-website/tar.gz/refs/heads/docusaurus","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247208142,"owners_count":20901570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["article","distributed-transaction","docsite","seata-website"],"created_at":"2024-10-29T16:12:07.971Z","updated_at":"2025-04-04T16:12:34.654Z","avatar_url":"https://github.com/apache.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Seata Official Website\n\n[![seata website deploy on github](https://github.com/apache/incubator-seata-website/actions/workflows/deploy.yml/badge.svg?branch=docusaurus)](https://github.com/apache/incubator-seata-website/actions/workflows/deploy.yml)\n\nAll website material of [https://seata.apache.org](https://seata.apache.org), which uses a open source framework: Docusaurus.\n\n## README.md\n\n- en [English](README.md)\n- zh_CN [简体中文](readme/README.zh_CN.md)\n\n### Quick Start\n\n1. `npm install`\n\n2. `npm run start` for starting Seata's **English** webpage in your local machine.\n\n    `npm run start-zh-cn` for starting Seata's **Chinese Simplified** webpage in your local machine.\n\n3. Visit\n\n```text\nlocalhost:3000/\n```\n\n### Build\n\n1. `npm run build`\n\n2. `npm run serve`\n\n3. Visit\n\n```text\nlocalhost:3000/\n```\n\n## Requirements\n\nBase docusaurus **2.4.1**\nNode.js version **19.5.0**\n\n## Note for i18n\n\nPlease be noted that **locale switching function doesn't work** if you start the website in development mode using `npm run start-zh-cn` or `npm run start`. Please run it in production mode using the build-and-serve process to enable the locale switching function.\n\n## Overview of the Website Structure\n\nWe use the **Docusaurus internationalization (i18n)** to support both English(en) and Chinese Simplified(zh-cn) Seata Website. Besides, we apply **Docusaurus Versioning** to get versioned docs.\n\nOur website stucture with i18n and versioning looks like below:\n\n```text\nwebsite\n├── sidebars.json        # sidebar for the current docs version\n├── docs                 # docs directory for the current docs version\n│   ├── foo\n│   │   └── bar.md       # https://mysite.com/docs/next/foo/bar\n│   └── hello.md         # https://mysite.com/docs/next/hello\n├── versions.json        # file to indicate what versions are available\n├── versioned_docs\n│   ├── version-1.1.0\n│   │   ├── foo\n│   │   │   └── bar.md   # https://mysite.com/docs/foo/bar\n│   │   └── hello.md\n│   └── version-1.0.0\n│       ├── foo\n│       │   └── bar.md   # https://mysite.com/docs/1.0.0/foo/bar\n│       └── hello.md\n├── versioned_sidebars\n│   ├── version-1.1.0-sidebars.json\n│   └── version-1.0.0-sidebars.json\n├── blog\n├── docusaurus.config.js\n├── package.json\n├── i18n\n│   ├── en\n│   │   ├── docusaurus-plugin-content-docs\n│   │   │   ├── current\n│   │   │   ├── version-1.0.0\n│   │   │   └── version-1.1.0\n│   │   ├── docusaurus-plugin-content-blog\n│   │   └── ...\n│   └── zh-cn\n│   │   ├── docusaurus-plugin-content-docs\n│   │   │   ├── current\n│   │   │   ├── version-1.0.0\n│   │   │   └── version-1.1.0\n│   │   ├── docusaurus-plugin-content-blog\n│   │   └── ...\n```\n\n## How To Add Documents\n\n### Directories Related to Adding Documents\n\ndocs - Contain the current (latest version) documents (placeholder for sidebar indexing purposes)\n    Document Content should be `Placeholder. DO NOT DELETE.`\n\nsidebars.json - Set the sidebar for the current (latest version) documents.\n\nversioned_docs - Contain the previous version documents (placeholder for sidebar indexing purposes)\n    Document Content should be `Placeholder. DO NOT DELETE.`\n\nversioned_sidebars - Set the sidebar for the specific previous versions documents.\n\ni18n-`en`-docusaurus-plugin-content-docs-`current` - Contain the actual **latest version** English documents.\ni18n-`en`-docusaurus-plugin-content-docs-`version-1.0.0` - Contain the actual **1.0.0 version** English documents.\n\ni18n-`zh-cn`-docusaurus-plugin-content-docs-`current` - Contains the actual **latest version** Simplified Chinese documents.\ni18n-`zh-cn`-docusaurus-plugin-content-docs-`version-1.0.0` - Contain the actual **1.0.0 version** Simplified Chinese documents.\n\n### Summary of Adding Documents\n\nSteps to add a document for the **latest version**:\n\n1. Place placeholder document under the docs directory which is located in the root directory.\n2. Update sidebar.js, add a new entry to the path of this document.\n3. Place the English document under the i18-`en`-docusaurus-plugin-content-docs-`current` directory.\n4. Place the Chinese document under the i18-`zh-cn`-docusaurus-plugin-content-docs-`current` directory.\n\nSteps to add a document for a **previous version**:\n\n1. Place a placeholder document under the specific versioned_docs directory for the desired version which is located in the root directory.\n2. Update specific versioned_sidebars file, add a new entry to the path of this document.\n3. Place the English document under the i18-`en`-docusaurus-plugin-content-docs-`specific version number` directory.\n4. Place the Chinese document under the i18-`zh-cn`-docusaurus-plugin-content-docs-`specific version number` directory.\n\n\u003e Notes: Corresponding to Chinese file and English file of same contents, and the Chinese and English file names should be consistent.\n\n## How To Add Blogs\n\nWe don't have a versioned blog, so it's easier to add a blog. When adding a new blog, it is automatically added in the Blog sidebar, where the order of blogs is sorted by the `date` field in SEO in the blog file.\n\n### Directories Related to Adding Blogs\n\nblog - Contain the blogs(placeholder for blog sidebar indexing purposes)\n    Blog Content should be `Placeholder. DO NOT DELETE.`\n\ni18n-`en`-docusaurus-plugin-content-blog - Contain all the actual English blogs.\n\ni18n-`zh-cn`-docusaurus-plugin-content-blog - Contain all the actual Simplified Chinese blogs.\n\n### Summary of Adding Blogs\n\nSteps to add a blog:\n\n1. Place placeholder blog under the blog directory which is located in the root directory.\n2. Place the English blog under the i18-`en`-docusaurus-plugin-content-blog directory.\n3. Place the Chinese blog under the i18-`zh-cn`-docusaurus-plugin-content-blog directory.\n\n\u003e Notes: Corresponding to Chinese file and English file of same contents, and the Chinese and English file names should be consistent.\n\n## SEO Needed in Both Docs and Blogs\n\nThe type is:\n\n```text\n---\ntitle: title\nkeywords: [keywords1,keywords2]\ndescription: some description\nauthor: author name\ndate: 2018-12-29\ncustom_edit_url: https://github.com/apache/incubator-seata-website/blob/docusaurus/i18n/en/docusaurus-plugin-content-blog/quick-start-use-seata-and-dubbo-services.md\n---\n```\n\n**Note:**\n\n1. `title` can not include `:`\n2. `keywords` must be a `Array`\n\u003c!-- 3. `custom_edit_url` is a link to the doc in this repo, required. --\u003e\n\n## Note for .md file\n\n1. Do not use un correct html tag like `\u003cimg\u003e、\u003cbr\u003e`, replace with `\u003cimg /\u003e \u003cbr /\u003e`\n2. If you want show `\u003cxx\u003e`, replace with `\u0026lt;xx\u0026gt;`\n3. Use `npm run lint` to check the style.\n\n## Others\n\nThis is official Docusaurus docs: [https://docusaurus.io/docs](https://docusaurus.io/docs)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fincubator-seata-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fincubator-seata-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fincubator-seata-website/lists"}