Welcome to the StaFi LSD Documentation repository.
Before you begin, ensure that you have Node.js installed on your system. If you don't have it installed, you can download it from the official Node.js website.
Additionally, this project uses pnpm as its package manager. If you don't have pnpm installed, you can install it globally using npm with the following command:
npm install -g pnpm
Once you have Node.js and pnpm installed, you can set up your local development environment. First, clone the repository to your local machine. Then, navigate to the project directory and install the necessary dependencies using pnpm:
pnpm i
After installing the dependencies, you can start the local development server with the following command:
pnpm dev
Now, you can visit localhost:3000 in your web browser to view the documentation.
To deploy the project, you can run pnpm build. Alternatively, you can use GitHub Actions if you prefer.
Our documentation uses Nextra, a static site generator for Next.js, and Markdown for formatting. Nextra components like steps, tabs, and callouts can also be used to structure the content effectively. For additional guidance, visit the Nextra Documentation.
Here are some examples of how to use various features:
- Headers:
#H1,##H2,###H3 - a:
[StaFi](https://stafi.io "title") - br:
\ - em:
* - Blockquotes:
>quote - img:
 - Lists:
- item,1. item - Strong emphasis:
*bold** - Strikethrough:
~~strikethrough~~
- [ ] rBNB
- [x] rETH
| Syntax | Description | Test Text |
|---|---|---|
| Header | Title | Here's this |
| Paragraph | Text | And more |
| Strikethrough |
| Syntax | Description | Test Text |
| :------------ | :---------: | ----------: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
| Strikethrough | | ~~Text~~ |
$a=\sqrt{b^2 + c^2}$.
To include an image in the documentation, you'll need to follow these steps:
- Place the Image in the Public Directory: All images should be placed in the
public/imagedirectory of the project. This allows the images to be accessed and displayed correctly when the documentation is viewed. - Reference the Image in Your Document: To display an image in a Markdown file, you can use the following syntax:
. ReplaceAlt Textwith a brief description of the image,path_to_imagewith the relative path to the image file (starting from thepublic/imagedirectory), andTitlewith the title of the image.
For example, if you have an image named logo.png in the public/image directory, and you want to display it in your document, you would use the following syntax:
This will display the image in your document with "StaFi Logo" as the alt text and title.
Remember, including relevant images can greatly enhance the readability and understanding of the documentation.
Nextra components like steps, tabs, and callouts can also be used to structure the content effectively. Here's how to use them:
import { Steps } from 'nextra/components'
<Steps>
### Step 1
Contents for step 1.
### Step 2
Contents for step 2.
</Steps>
import { Tab, Tabs } from 'nextra/components'
<Tabs items={['pnpm', 'npm', 'yarn']} defaultIndex="1">
...
</Tabs>
import { Callout } from 'nextra/components'
<Callout type="info" emoji="ℹ️">
Today is Friday.
</Callout>
We welcome contributions from anyone. Here's how you can contribute:
-
Edit the Markdown Document: Find the file you want to modify and click the 'Edit' button to make your changes.
-
Submit a Pull Request: Once you've made your changes, commit them and submit a pull request. Your changes will be reviewed and, if approved, merged into the main codebase.
If you're familiar with Git, you can also fork the repository, make changes in your fork, and then submit a pull request so that they can be reviewed and potentially merged into the main codebase.
This project is licensed under the MIT License.