Skip to content
This repository has been archived by the owner on Feb 12, 2023. It is now read-only.

Commit

Permalink
[Doc]: organize files and folders
Browse files Browse the repository at this point in the history
  • Loading branch information
201flaviosilva committed Apr 19, 2022
1 parent de7b369 commit 7428c56
Show file tree
Hide file tree
Showing 18 changed files with 47 additions and 517 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ const game = new Impacto.Game({
```


For more information about the Impacto API, please check the [Wiki](https://github.com/201flaviosilva/Impacto/wiki) or check the examples.
For more information about the Impacto API, please check the Doc or check the examples.
3 changes: 3 additions & 0 deletions docs/docs/examples/Games/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Games"
}
7 changes: 7 additions & 0 deletions docs/docs/examples/Games/pong.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Pong

In conjunction
4 changes: 4 additions & 0 deletions docs/docs/examples/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Examples",
"position": 3
}
7 changes: 7 additions & 0 deletions docs/docs/examples/hello-world.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
---

# Hello World

In conjunction
51 changes: 14 additions & 37 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,23 @@
sidebar_position: 1
---

# Tutorial Intro
# Impacto

Let's discover **Docusaurus in less than 5 minutes**.
## Introduction
Impacto is a simple render engine for HTML5 canvas. If you have any questions please ask in [Discussions (Forum)](https://github.com/201flaviosilva/Impacto/discussions).

## Getting Started
To get start developing with Impacto, check the [Getting Started](/docs/GetStarted) page.

Get started by **creating a new site**.
If you find any bug, please report it in [Issues](https://github.com/201flaviosilva/Impacto/issues) or make a [Pull Request](https://github.com/201flaviosilva/Impacto/pulls).

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
## Community

### What you'll need
Impacto is open source and still in development, but you can help us by contributing to the project and the growing community :)

- [Node.js](https://nodejs.org/en/download/) version 14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.

## Generate a new site

Generate a new Docusaurus site using the **classic template**.

The classic template will automatically be added to your project after you run the command:

```bash
npm init docusaurus@latest my-website classic
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

## Start your site

Run the development server:

```bash
cd my-website
npm run start
```

The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
- [NPM Package](https://www.npmjs.com/package/impacto);
- [GitHub Repository](https://github.com/201flaviosilva/Impacto);
- [Discussions](https://github.com/201flaviosilva/Impacto/discussions)
- [Issues](https://github.com/201flaviosilva/Impacto/issues);
- [Pull Request](https://github.com/201flaviosilva/Impacto/pulls);
- [Changelog](https://github.com/201flaviosilva/Impacto/blob/main/CHANGELOG.md);
- [Awesome](https://github.com/201flaviosilva/Impacto/blob/main/awesome-impacto.md);
4 changes: 4 additions & 0 deletions docs/docs/plugins/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Plugins",
"position": 4
}
4 changes: 0 additions & 4 deletions docs/docs/tutorial-basics/_category_.json

This file was deleted.

21 changes: 0 additions & 21 deletions docs/docs/tutorial-basics/congratulations.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/docs/tutorial-basics/create-a-blog-post.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/docs/tutorial-basics/create-a-document.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/docs/tutorial-basics/create-a-page.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/docs/tutorial-basics/deploy-your-site.md

This file was deleted.

Loading

0 comments on commit 7428c56

Please sign in to comment.