Skip to content

Commit

Permalink
feat: optimize home doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sanyuan0704 committed Oct 9, 2022
1 parent 4b7e979 commit ea9721f
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/.island/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,11 +136,11 @@ function getSidebar(lang: 'zh' | 'en') {
link: getLink('/guide/navbar')
},
{
text: getText('Home 页面', 'Home Page'),
text: getText('Home 主页', 'Home Page'),
link: getLink('/guide/home-page')
},
{
text: getText('API 页面', 'API Page'),
text: getText('API 预览页', 'API Page'),
link: getLink('/guide/api-page')
},
{
Expand Down
1 change: 1 addition & 0 deletions docs/en/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- **Fast**: Island is built on top of Vite, which is a modern build tool that aims to provide a faster and leaner development experience.
- **Flexible**: It has internal Mdx language support, which is a powerful way to write content. You can write, import and use React components in Markdown file.
- **Performant**: It is designed to be [island architecture](https://jasonformat.com/islands-architecture/), which means less javascript bundle, partial hydration and better performance about FCP, TTI.
- **Powerful**: Default theme includes a lot of features, such as `Dark Mode`, [`Home Page`](/en/guide/home-page), [`API Page`](/en/guide/api-page)[`Full-text Search`](/en/guide/search), [`i18n`](/en/guide/i18n) etc.

Next we will walk you through the steps to create a new Island.js doc site.

Expand Down
13 changes: 11 additions & 2 deletions docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pageType: home
hero:
name: Island
text: Vite & Mdx Powered Static Site Generator
tagline: Simple, powerful, and performant. Meet the modern SSG framework you've always wanted.
tagline: Simple, powerful, and performant.
image:
src: /island.png
alt: Island
Expand All @@ -18,12 +18,21 @@ hero:

features:
- title: "Vite: The DX that can't be beat"
details: With Markdown-centered content, it's built to help you focus on writing and deployed with minimum configuration.
details: Instant server start and HMR regardless of project size.
icon: 🚀
- title: 'MDX: The flexible way to write content'
details: MDX is a powerful way to write content. You can use React components in Markdown.
icon: 📦
- title: 'Islands Arch: The higher performance in production'
details: Designed to be islands architecture, means less javascript bundle, partial hydration and better performance about FCP, TTI.
icon:
- title: 'Feature Rich: The powerful features'
details: Out of box support for i18n, full-text search etc.
icon: 🛠️
- title: 'TypeScript: Typed API Support'
details: Written in TypeScript, with type definitions for APIs.
icon: 🔑
- title: 'Customizable: The flexible way to customize'
details: You can customize the theme ui and the build process.
icon: 🎨
---
2 changes: 1 addition & 1 deletion docs/zh/guide/api-page.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# API 页面
# API 预览页

Island.js 默认主题内置了 API 页面。

Expand Down
1 change: 1 addition & 0 deletions docs/zh/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- **开发体验好**: 基于 Vite 进行构建,启动和热更新速度极快。
- **语法灵活**: 内置 MDX 支持,也就是说你可以在 Markdown 中使用 React 组件。
- **高性能**: 基于[孤岛架构](https://jasonformat.com/islands-architecture/), 实现了 Partial Hydration,意味着更少的客户端 JavaScript 和更少的运行时开销。
- **功能强大**: 默认主题内置了`夜间模式`[`Home 主页`](/zh/guide/home-page)[`API 预览页`](/zh/guide/api-page)[`全文搜索`](/zh/guide/search)[`国际化`](/zh/guide/i18n)等等能力。

接下来,我们将从零开始搭建一个基于 Island.js 的文档站点。

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/guide/home-page.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Home 页面
# Home 主页

Island.js 默认主题内置了 Home 页面,你可以通过书写 markdown 的 Front Matter 来配置它。举个简单的例子:

Expand Down
9 changes: 9 additions & 0 deletions docs/zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,13 @@ features:
- title: '孤岛架构: 更高的生产性能'
details: 采用 Islands 架构,意味着更少的 JavaScript 代码、局部 hydration, 从而带来更好的首屏性能。
icon:
- title: '功能丰富: 一站式解决方案'
details: 对全文搜索、国际化等常见功能可以做到开箱即用。
icon: 🛠️
- title: 'TypeScript: 优秀的类型支持'
details: 使用 TypeScript 编写,提供了优秀的类型支持,让你的开发更加顺畅。
icon: 🔑
- title: '扩展性强: 提供多种自定义能力'
details: 通过其扩展机制,你可以轻松的扩展 Island 的主题 UI 和构建能力。
icon: 🎨
---

0 comments on commit ea9721f

Please sign in to comment.