Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelliao committed Jan 5, 2024
1 parent 65aa058 commit 9e18455
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions source/books/gitsite-guide/10-introduction/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
# GitSite Introduction

GitSite是一个基于现代Web技术的文档平台,任何个人和团队都可以通过Git组织并编写文档,并自动生成符合HTML5标准的Web网站。

GitSite is a document platform based on modern Web technology, any individual and team can organize and write documents through Git, and automatically generate HTML5-compliant web sites.

![](test.png)

Git是目前最流行的版本控制系统,而GitHub等托管平台则提供了强大而可靠的Git仓库托管。许多个人和团队在GitHub这样的平台通过Git管理Markdown文档。GitSite不要求使用专业的前端构建工具,也无需繁琐的配置,即可快速基于Git仓库的Markdown 文档生成Web网站,而网站的所有内容均为静态页面。

Git은 현재 가장 널리 사용되는 버전 제어 시스템이며 GitHub와 같은 호스팅 플랫폼은 강력하고 안정적인 Git 리포지토리 호스팅을 제공합니다. 많은 개인과 팀이 GitHub와 같은 플랫폼에서 Git을 통해 Markdown 문서를 관리합니다. GitSite는 전문적인 프런트 엔드 빌드 도구를 사용할 필요가 없으며 Git 리포지토리의 Markdown 문서를 기반으로 웹 사이트를 빠르게 생성하기 위해 번거로운 구성이 필요하지 않으며 사이트의 모든 콘텐츠는 정적 HTML 페이지입니다.

Git は現在最も人気のあるバージョン管理システムであり、GitHub などのホスティング プラットフォームは、Git リポジトリの強力で信頼性の高いホスティングを提供します。 多くの個人やチームは、GitHub などのプラットフォーム上の Git を通じて Markdown ドキュメントを管理しています。 GitSite では、専用のフロントエンド ビルド ツールを使用する必要がなく、Git リポジトリからの Markdown ドキュメントに基づいて Web サイトを迅速に生成するための面倒な構成も必要ありません。サイト上のすべてのコンテンツは静的 HTML ページです。

Git is currently the most popular version control system, and hosting platforms such as GitHub provide powerful and reliable hosting of Git repositories. Many individuals and teams manage Markdown documents through Git on platforms like GitHub. GitSite does not require the use of specialized front-end build tools, nor does it require cumbersome configuration to quickly generate a web site based on Markdown documents from Git repositories, and all contents on the site is static HTML pages.

## GitSite适合哪些用户

GitSite的设计目标是支持不多于1万个Markdown文档的Git仓库,他们通常是产品文档、知识库、个人博客或者一本书籍。如果文档的数量非常庞大,您可能需要考虑使用数据库管理,因为GitSite基于静态页面的方式会使得前端搜索显著变慢。
## Design Goals

GitSite is designed to support Git repositories with no more than 10,000 Markdown documents, usually product documentation, knowledge bases, personal blogs, or a book. If the number of documents is very large, you may want to consider using database management, as GitSite's static page-based approach can slow down front-end searches significantly.

0 comments on commit 9e18455

Please sign in to comment.