Git Product home page Git Product logo

stafi-doc's Introduction

Install

Install Node and pnpm

Install Node.js, and run npm install pnpm -g

Install Dependencies & Local Development

First, run pnpm i to install the dependencies.

Then, run pnpm dev to start the development server and visit localhost:3000.

Deploy

run pnpm build or use Github Action

Guide

nextra guide: https://nextra.site/docs/guide

Markdown

  • h1: #
  • h2: ##
  • h3: ###
  • a: [StaFi](https://stafi.io "title")
  • blockquote: > A greater than
  • br: \
  • em: * *
  • img: ![Alt text](/image/logo.png "title")
  • li: - StaFi
  • ol: 1.
  • strong: ** **
  • strikethrough: ~~ ~~

Task List

- [ ] rBNB
- [x] rETH

Table

| Syntax        | Description |   Test Text |
| :------------ | :---------: | ----------: |
| Header        |    Title    | Here's this |
| Paragraph     |    Text     |    And more |
| Strikethrough |             |    ~~Text~~ |

Latex

The **Pythagorean equation**: $a=\sqrt{b^2 + c^2}$.

Component

Steps

import { Steps } from 'nextra-theme-docs'
 
<Steps>
 
### Step 1
 
Contents for step 1.
 
### Step 2
 
Contents for step 2.
 
</Steps>

Tabs

import { Tab, Tabs } from 'nextra-theme-docs'
 
<Tabs items={['pnpm', 'npm', 'yarn']} defaultIndex="1">
  ...
</Tabs>

Callout

import { Callout } from 'nextra/components'
 
<Callout type="info" emoji="ℹ️">
  Today is Friday.
</Callout>

Image

  • Image path: public/image
  • Use: ![Alt text](/image/logo.png "title")

Contribute

Docs is an open-source project, and anyone can contribute to it.

  • Edit the markdown doc.
  • Submit a pull request.
  • Review and merge the pull request.

License

This project is licensed under the MIT License.

stafi-doc's People

Contributors

0xsignal avatar frostfoxy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.