Skip to content

Commit

Permalink
update entry page of documentation site
Browse files Browse the repository at this point in the history
  • Loading branch information
Rosemoe committed Feb 11, 2024
1 parent 1678d9c commit bb880a6
Show file tree
Hide file tree
Showing 9 changed files with 184 additions and 46 deletions.
4 changes: 3 additions & 1 deletion .vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,11 @@ function nav(): DefaultTheme.NavItem[] {
function guideReference(): DefaultTheme.SidebarItem[] {
return [
{
text: 'Introducation',
collapsed: false,
items: [
{
text: 'Getting started',
text: 'Getting Started',
link: '/getting-started'
}
]
Expand Down
2 changes: 2 additions & 0 deletions .vitepress/config/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ function nav(): DefaultTheme.NavItem[] {
function guideReference(): DefaultTheme.SidebarItem[] {
return [
{
text: '简介与入门',
collapsed: false,
items: [
{
text: '快速开始',
Expand Down
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# sora-editor-docs
documentation for sora-editor
<div align="center">

![Banner](public/editor_banner.jpg)
---

<h1>Documentation for sora-editor</h1>

</div>

## Welcome
Welcome to [sora-editor](https://github.com/Rosemoe/sora-editor) documentation repository!
The documentation site is available at [GitHub Pages](https://project-sora.github.io/sora-editor-docs/).

## Contribution
You are welcome to help make the documentation better. We need your efforts to improve the quality and coverage of the documentation and translate the documentation to other languages so that more people can read it easily.
1 change: 0 additions & 1 deletion guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Get started

Add to your app's dependencies:

[![Maven Central](https://img.shields.io/maven-central/v/io.github.Rosemoe.sora-editor/editor.svg?label=Maven%20Central)]((https://search.maven.org/search?q=io.github.Rosemoe.sora-editor%20editor))
Expand Down
28 changes: 25 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,38 @@
layout: home

title: Sora Editor
titleTemplate: a cool and optimized code editor on Android platform
titleTemplate: High-Performance Android Code Editor

hero:
name: Sora Editor
tagline: A cool and optimized code editor on Android platform
text: High-Performance Android Code Editor
tagline: Powerful, optimized and pluggable. Here's what you need for your code viewing and editting apps.
actions:
- theme: brand
text: Get Started
link: /guide/getting-started
- theme: alt
text: View on GitHub
link: https://github.com/Rosemoe/sora-editor
---

features:
- icon: 🛠️
title: Fast Integration
details: Effortlessly integrate the editor into your project with documentation and detailed javadoc.
- icon: 🚀
title: Smooth User Experience
details: Enjoy coding comfort with suitable animations and trasitions.
- icon:
title: High Peroformance
details: Run analysis in background workers, incrementally. Get syntax-highlight and code completions in a glance.
- icon:
title: Active Development
details: We are still continuously enhancing the functionality of the editor to keep it at the forefront of mobile editors.
---

<style>
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #ec407a);
}
</style>
149 changes: 114 additions & 35 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sora-editor-docs",
"version": "0.22.2",
"version": "0.23.2",
"type": "module",
"description": "documentation for sora-editor",
"scripts": {
Expand Down
Binary file added public/editor-banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 24 additions & 3 deletions zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,37 @@
layout: home

title: Sora Editor
titleTemplate: 一款高效的安卓代码编辑器
titleTemplate: 高性能安卓端代码编辑器

hero:
name: Sora Editor
tagline: 一款高效的安卓代码编辑器
text: 高性能安卓端代码编辑器
tagline: 功能强大、性能优化、扩展简易。这是您构建移动端代码编辑程序的不二之选!
actions:
- theme: brand
text: 快速开始
link: /zh/guide/getting-started
- theme: alt
text: GitHub
link: https://github.com/Rosemoe/sora-editor
---
features:
- icon: 🛠️
title: 快速集成
details: 简单易集成,轻轻松松将编辑器集成到您的项目中。
- icon: 🚀
title: 丝滑体验
details: 适时的动画和过渡,让您更加享受您的代码编辑之旅。
- icon:
title: 性能高强
details: 通过后台增量分析,使您在眨眼间即可获得代码高亮和精准的提示。
- icon:
title: 更新活跃
details: 我们仍在不断增强编辑器的功能,让它走在移动端编辑器的前列。
---

<style>
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #ec407a);
}
</style>

0 comments on commit bb880a6

Please sign in to comment.