Skip to content

Commit 05ccfd3

Browse files
committed
update docs
1 parent 39300d6 commit 05ccfd3

File tree

4 files changed

+28
-3
lines changed

4 files changed

+28
-3
lines changed

docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: FrameScript Docs
33
sidebar_position: 1
44
---
55

6-
FrameScript is a code-first motion graphics toolkit built on React, Electron, and Rust.
6+
FrameScript is a code-first motion graphics and video editing toolkit built with React and CSS.
77
You author scenes as React components, preview them in Studio, and render video through headless Chromium.
88

99
## Quick start

docs/docusaurus.config.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ const config = {
3434
},
3535
navbar: {
3636
title: "FrameScript Docs",
37-
items: [{ type: "localeDropdown", position: "right" }],
37+
items: [
38+
{
39+
href: "https://github.com/frame-script/FrameScript",
40+
label: "GitHub",
41+
position: "right",
42+
className: "navbar__github",
43+
"aria-label": "GitHub repository",
44+
},
45+
{ type: "localeDropdown", position: "right" },
46+
],
3847
},
3948
},
4049
};

docs/i18n/ja/docusaurus-plugin-content-docs/current/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: FrameScript ドキュメント
33
sidebar_position: 1
44
---
55

6-
FrameScript は React / Electron / Rust を組み合わせた、コードファーストなモーショングラフィックス基盤です
6+
FrameScript は React / CSS で描画する、コードファーストな モーショングラフィックス & 動画編集 基盤です
77
React コンポーネントとしてシーンを記述し、Studio でプレビューし、ヘッドレス Chromium で書き出します。
88

99
## クイックスタート

docs/src/css/custom.css

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,22 @@ body {
6262
letter-spacing: -0.01em;
6363
}
6464

65+
.navbar__github {
66+
display: inline-flex;
67+
align-items: center;
68+
gap: 6px;
69+
}
70+
71+
.navbar__github::before {
72+
content: "";
73+
width: 16px;
74+
height: 16px;
75+
display: inline-block;
76+
background-color: currentColor;
77+
-webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath d='M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38C13.71 14.53 16 11.54 16 8c0-4.42-3.58-8-8-8z'/%3E%3C/svg%3E") no-repeat center / contain;
78+
mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath d='M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38C13.71 14.53 16 11.54 16 8c0-4.42-3.58-8-8-8z'/%3E%3C/svg%3E") no-repeat center / contain;
79+
}
80+
6581
.menu__link--active,
6682
.menu__link--active:not(.menu__link--sublist) {
6783
background: linear-gradient(90deg, rgba(34, 211, 238, 0.16), transparent);

0 commit comments

Comments
 (0)