Skip to content

Commit

Permalink
solive to SoLive
Browse files Browse the repository at this point in the history
(cherry picked from commit 1025b53)
  • Loading branch information
AmazingAng authored and chongqiangchen committed May 14, 2023
1 parent 00d9c91 commit 8daf442
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion apps/demo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Solive Demo
# SoLive Demo

## run
```
Expand Down
6 changes: 3 additions & 3 deletions apps/doc/docs/solive-props.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ hide_title: true
| rounded | Window corner radius | string | 12px | - |
| disableValidation | Whether to disable validation | boolean | false | - |
| monacoEditorOptions | Monaco editor configuration | (Refer to [IStandaloneEditorConstructionOptions](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IStandaloneEditorConstructionOptions.html)) | - | - |
| fileNav | Top file navigation | TFileNav | (Refer to [TFileNav](/docs/solive-props#tfilenav)) | - |
| console | Log block | TConsole | (Refer to [TConsole](/docs/solive-props#tconsole)) | - |
| deploy | Deployment block | TDeploy | (Refer to [TDeploy](/docs/solive-props#tdeploy)) | - |
| fileNav | Top file navigation | TFileNav | (Refer to [TFileNav](/docs/SoLive-props#tfilenav)) | - |
| console | Log block | TConsole | (Refer to [TConsole](/docs/SoLive-props#tconsole)) | - |
| deploy | Deployment block | TDeploy | (Refer to [TDeploy](/docs/SoLive-props#tdeploy)) | - |

## TFileNav

Expand Down
16 changes: 8 additions & 8 deletions apps/doc/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const SECTIONS = [

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Solive",
title: "SoLive",
tagline: "Online playground for Solidity",
favicon: "img/favicon.ico",

Expand All @@ -43,8 +43,8 @@ const config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "Solive", // Usually your GitHub org/user name.
projectName: "Solive", // Usually your repo name.
organizationName: "SoLive", // Usually your GitHub org/user name.
projectName: "SoLive", // Usually your repo name.

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
Expand All @@ -57,7 +57,7 @@ const config = {
locales: ["en"],
},

themes: ['solive-docusaurus-theme-code'],
themes: ['SoLive-docusaurus-theme-code'],

presets: [
[
Expand Down Expand Up @@ -93,9 +93,9 @@ const config = {
// Replace with your project's social card
image: "img/docusaurus-social-card.jpg",
navbar: {
title: "Solive",
title: "SoLive",
logo: {
alt: "Solive",
alt: "SoLive",
src: "img/logo_300x300.png",
},
items: [
Expand Down Expand Up @@ -137,12 +137,12 @@ const config = {
items: [
{
label: "GitHub",
href: "https://github.com/WTFAcademy/solive",
href: "https://github.com/WTFAcademy/SoLive",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Solive, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} SoLive, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ hide_title: true
## 安装

1. 首先我们需要安装 `solive-docusaurus-theme-code` 插件:
1. 首先我们需要安装 `SoLive-docusaurus-theme-code` 插件:
```bash npm2yarn
npm install --save solive-docusaurus-theme-code
```
Expand All @@ -33,7 +33,7 @@ module.exports = {
```\
```

2. 你可以在代码块中配置solive相关属性 `height`(具体参考[属性表](./introduction.mdx)):
2. 你可以在代码块中配置SoLive相关属性 `height`(具体参考[属性表](./introduction.mdx)):
```md
```solidity solive height=300px
// your code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ slug: /introduction
hide_title: true
---
# 介绍
Solive 是一个轻量级且灵活的在线 Solidity 试验场,受 Remix-IDE 和 React-Live 启发。Solive 使您能够在 React 组件中编辑、编译、部署和与 Solidity 智能合约进行交互。您可以将 Solive 集成到您的网站或教程中,让用户直接在浏览器中执行 Solidity 代码。此外,Solive 还兼容移动浏览器。
SoLive 是一个轻量级且灵活的在线 Solidity 试验场,受 Remix-IDE 和 React-Live 启发。SoLive 使您能够在 React 组件中编辑、编译、部署和与 Solidity 智能合约进行交互。您可以将 SoLive 集成到您的网站或教程中,让用户直接在浏览器中执行 Solidity 代码。此外,SoLive 还兼容移动浏览器。

## 使用场景:
1. 教育:在 [WTF Solidity](https://github.com/AmazingAng/WTF-Solidity) 教程中,我们将使用 Solive 替换传统的代码块,让学生能够同时阅读和运行代码。
2. 开发人员入门:Layer2 项目可以利用 Solive 吸引并招募以太坊开发者。
1. 教育:在 [WTF Solidity](https://github.com/AmazingAng/WTF-Solidity) 教程中,我们将使用 SoLive 替换传统的代码块,让学生能够同时阅读和运行代码。
2. 开发人员入门:Layer2 项目可以利用 SoLive 吸引并招募以太坊开发者。

## 如何实现
Solive 的设计轻量且灵活。它仅包含编辑、编译、部署和与智能合约进行交互所需的关键模块。
SoLive 的设计轻量且灵活。它仅包含编辑、编译、部署和与智能合约进行交互所需的关键模块。
1. 编辑模块:我们使用 Monaco Editor 作为代码编辑器。
2. 编译模块:我们使用 `solcjs`,根据所选的 Solidity 版本进行智能合约编译。
3. 部署模块:我们使用 `ethersjs V5``ethereumjs vm` 的组合将编译后的合约部署到本地 EVM 上。
Expand Down
4 changes: 2 additions & 2 deletions apps/doc/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ export default function HomepageFeatures(): JSX.Element {
<section className={styles.features}>
<div className={styles.overview}>
<div className={styles.overviewText}>
<h2 className={styles.overviewTextTitle}>Say hi to Solive 🤟</h2>
<h2 className={styles.overviewTextTitle}>Say hi to SoLive 🤟</h2>
<br/>
<p className={styles.overviewTextDes}>Solive is a flexible online playground for Solidity smart contracts, inspired by remix-IDE and react-live. Solive enables you to edit, compile, deploy, and interact with solidity smart contracts in one React component. You can embed solive into your website/tutorials and let users run solidity code in the browser. Solive is also compatible with mobile browsers.</p>
<p className={styles.overviewTextDes}>SoLive is a flexible online playground for Solidity smart contracts, inspired by remix-IDE and react-live. SoLive enables you to edit, compile, deploy, and interact with solidity smart contracts in one React component. You can embed SoLive into your website/tutorials and let users run solidity code in the browser. SoLive is also compatible with mobile browsers.</p>
</div>
</div>
<div className={styles.featureTitle}>What's next:</div>
Expand Down

0 comments on commit 8daf442

Please sign in to comment.