Skip to content

Commit fa7d9d9

Browse files
committed
refactor: update Portuguese and english documentation file
1 parent efe8ad1 commit fa7d9d9

8 files changed

+144
-1
lines changed

docs/src/en/guide/getting-started.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Getting Started
2+
3+
## Installation
4+
5+
To install DsacJs
6+
7+
::: code-group
8+
9+
```bash [npm]
10+
npm install dsacjs
11+
```
12+
13+
```bash [yarn]
14+
yarn add dsacjs
15+
```
16+
17+
```bash [pnpm]
18+
pnpm add dsacjs
19+
```
20+
21+
```bash [bun]
22+
bun add dsacjs
23+
```
24+
25+
:::
26+
27+
## Usage
28+
29+
Here's an example of how you can use DsacJs to create a simple stack data structure:
30+
31+
```typescript
32+
import { Stack } from "dsacjs";
33+
34+
const stack = new Stack<number>();
35+
36+
stack.push(1);
37+
stack.push(2);
38+
stack.push(3);
39+
40+
console.log(stack.pop()); // 3
41+
```

docs/src/en/guide/index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Guide
2+
3+
This guide will help you to get started with the project.
4+
5+
## Introduction
6+
7+
This project is a simple project that demonstrates how to use the project.
8+
9+
## Getting Started
10+
11+
Read the [Getting Started](getting-started.md) guide to get started with the project.

docs/src/en/guide/introduction.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# DsacJs - Data Structures - Algorithm - Toolkit Collection
2+
3+
## Introduction
4+
5+
A high-performance JavaScript and TypeScript library offering a comprehensive set of efficient data structures. Simplify your algorithm implementation and data manipulation with optimized, easy-to-use tools.
6+
7+
[![npm](https://img.shields.io/npm/v/dsacjs)](https://www.npmjs.com/package/dsacjs)
8+
9+
## Features
10+
11+
- **High Performance**: Utilizes the latest JavaScript and TypeScript features to provide optimized data structures.
12+
13+
- **Comprehensive Toolkit**: Offers a wide range of data structures and algorithms to simplify your development process.
14+
15+
- **Easy to Use**: Provides a simple, intuitive API that makes it easy to work with complex data structures.
16+
17+
- **TypeScript Support**: Fully supports TypeScript, providing type safety and improved code quality.
18+
19+
- **Modular Design**: Each data structure is implemented as a separate module, allowing you to import only what you need.
20+
21+
- **Well Documented**: Comprehensive documentation and examples to help you get started quickly.
22+
23+
- **Open Source**: DsacJs is open source and available under the MIT license.
24+
25+
- **Supports Node.js and Browsers**: Works in both Node.js and browser environments.
26+
27+
- **Supoorts ES6 Modules and CommonJS**: Supports both ES6 modules and CommonJS module systems.
28+
29+
## Documentation
30+
31+
For more information on how to use DsacJs, check out the [documentation](https://gabriel-logan.github.io/DsacJs/guide/introduction.html).
32+
33+
## Contributing
34+
35+
If you'd like to contribute to DsacJs, please read our [contributing guidelines](https://github.com/gabriel-logan/DsacJs/blob/main/CONTRIBUTING.md)
36+
37+
## License
38+
39+
DsacJs is [MIT licensed](https://github.com/gabriel-logan/DsacJs/blob/main/LICENSE)
40+
41+
## Author
42+
43+
Gabriel Logan
44+
45+
## Acknowledgements
46+
47+
This project was inspired by the [Java Collections Framework](https://docs.oracle.com/javase/8/docs/technotes/guides/collections/overview.html)
48+
49+
## Contributors
50+
51+
Thanks to all the contributors who have helped make DsacJs better!

docs/src/en/index.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: home
3+
4+
hero:
5+
name: "DsacJs"
6+
text: "TS/JS Library"
7+
tagline: "Data Structures - Algorithm - Toolkit Collection"
8+
icon: 🛠️
9+
image:
10+
src: https://gabriel-logan.github.io/DsacJs/logo-transparent.png
11+
alt: Banner
12+
actions:
13+
- theme: brand
14+
text: Introduction
15+
link: /guide/introduction
16+
- theme: alt
17+
text: View on GitHub
18+
link: "https://github.com/gabriel-logan/DsacJs"
19+
20+
features:
21+
- title: 📇 Algorithm
22+
details: Various functions with ready-to-use algorithms, in an easy way.
23+
link: /documentation/algorithms/
24+
25+
- title: 📈 Data Structures
26+
details: A collection of data structures, with a simple and easy-to-use API.
27+
link: /documentation/data-structures/
28+
29+
- title: ℹ️ Toolkit
30+
details: A set of tools to help you in your daily tasks.
31+
link: /documentation/toolkit/
32+
33+
footer:
34+
text: "Made with ❤️ by Gabriel Logan"
35+
actions:
36+
- text: "GitHub"
37+
link: "https://github.com/gabriel-logan/DsacJs"
38+
- text: "NPM"
39+
link: "https://www.npmjs.com/package/dsacjs"
40+
---
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/src/pt/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ hero:
77
tagline: "Estruturas de Dados - Algoritmos - Coleção de Ferramentas"
88
icon: 🛠️
99
image:
10-
src: ./logo-transparent.png
10+
src: https://gabriel-logan.github.io/DsacJs/logo-transparent.png
1111
alt: Banner
1212
actions:
1313
- theme: brand

0 commit comments

Comments
 (0)