Skip to content

Commit

Permalink
feat: add some config
Browse files Browse the repository at this point in the history
  • Loading branch information
richerfu committed Mar 4, 2024
1 parent 73c8b0a commit d00e3c8
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 2 deletions.
12 changes: 10 additions & 2 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ export default defineConfig({
],
socialLinks: [
{icon: 'github', link: 'https://github.com/ohos-rs'}
]
}
],
editLink: {
pattern: 'https://github.com/ohos-rs/ohos-rs.github.io/tree/master/src/:path',
text: 'Edit this page on GitHub'
},
lastUpdated: {
text: "Last updated"
}
},

})
4 changes: 4 additions & 0 deletions src/basic.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
editLink: true
---

## What's `ohos-rs`?

The runtime of HarmonyOS is very similar to Node.js, but there are slight differences in some logic, so it forked the code of [napi-rs](https://github.com/napi-rs/napi-rs) and made some modifications. The overall functions are basically aligned with napi-rs.
Expand Down
4 changes: 4 additions & 0 deletions src/basic/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
editLink: true
---

# Quick Start

We provide a cli tool to simplify some action. For example: `init`, `build` and so on.
Expand Down
4 changes: 4 additions & 0 deletions src/basic/simple-project.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
editLink: true
---

# Simple Project

We can use tool to initial our HarmonyOS's project, and it's also possible for us to initial project with standard rust project.
Expand Down
4 changes: 4 additions & 0 deletions src/cli/build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
editLink: true
---

# Build

As another useful subcommand, it helps us to build the final binary and generate `.d.ts`. Standard command will be:
Expand Down
4 changes: 4 additions & 0 deletions src/cli/init.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
editLink: true
---

# Init

`ohrs` provide some useful subcommand to help us initial and build project.
Expand Down

0 comments on commit d00e3c8

Please sign in to comment.