Skip to content

README #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions AUTHORING.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,38 @@

# Authoring
# Autoria

This describes important stuff about authoring new articles of the tutorial.
Isso descreve coisas importantes sobre a autoria de novos artigos do tutorial.

## Internal links
## Links internos

All tutorial links should start from the root, not including the domain.
Todos os links do tutorial devem começar da raiz, não incluindo o domínio.

OK:
Tudo bem:

```md
We'll cover that in the chapter [about functions](/function-basics)
Abordaremos isso no capítulo [sobre funções](/function-basics)
```

Not ok:
Não está bem:

```md
We'll cover that in the chapter [about functions](https://javascript.info/function-basics)
Abordaremos isso no capítulo [sobre funções](https://javascript.info/function-basics)
```

Also, to reference a chapter, there's a special "info:" scheme, like this:
Além disso, para registrar referência a um capítulo, há um esquema especial "info:", como este:

```md
We'll cover that in the chapter <info:function-basics>.
Abordaremos isso no capítulo <info:function-basics>.
```

Becomes:
Torna-se:

```html
We'll cover that in the chapter <a href="/function-basics">Function basics</a>.
Abordaremos isso no capítulo <a href="/function-basics">Funções básicas</a>.
```

The title is auto-inserted from the referenced article. That has the benefit of keeping the right title if the article gets renamed.
O título é inserido automaticamente a partir do artigo referenciado. Isso tem a vantagem de manter o título correto se o artigo for renomeado.

## TODO

Ask @iliakan to for more details.
Pergunte a @iliakan para mais detalhes.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# The Modern JavaScript Tutorial

This repository hosts the English content of the Modern JavaScript Tutorial, published at [https://javascript.info](https://javascript.info).
Este repositório hospeda o conteúdo em inglês do Modern JavaScript Tutorial, publicado em [https://javascript.info](https://javascript.info).

## Translations
## Traduções

We'd like to make the tutorial available in many languages. Please help us to translate.
Gostaríamos de disponibilizar o tutorial em vários idiomas. Por favor, ajude-nos a traduzir.

See <https://javascript.info/translate> for the details.
Veja <https://javascript.info/translate> para mais detalhes.

## Contributions
## Contribuições

We'd also like to collaborate on the tutorial with other people.
Também gostaríamos de colaborar no tutorial com outras pessoas.

Something's wrong? A topic is missing? Explain it to people, add it as PR 👏
Algo está errado? Falta um tópico? Explique para as pessoas, adicione como PR 👏

**You can edit the text in any editor.** The tutorial uses an enhanced "markdown" format, easy to grasp. And if you want to see how it looks on-site, there's a server to run the tutorial locally at <https://github.com/javascript-tutorial/server>.
**Você pode editar o texto em qualquer editor.** O tutorial usa um formato "markdown" aprimorado, fácil de entender. E se você quiser ver como fica no local, há um servidor para executar o tutorial localmente em <https://github.com/javascript-tutorial/server>.

The list of contributors is available at <https://javascript.info/about#contributors>.
A lista de contribuidores está disponível em <https://javascript.info/about#contributors>.

## Structure
## Estrutura

Every chapter, article, or task has its folder.
Cada capítulo, artigo ou tarefa tem sua pasta.

The folder is named like `N-url`, where `N` is a number for the sorting purposes and `URL` is the URL part with the title of the material.
A pasta é nomeada como `N-url`, onde `N` é um número para fins de classificação e `URL` é a parte da URL com o título do material.

The type of the material is defined by the file inside the folder:
O tipo do material é definido pelo arquivo dentro da pasta:

- `index.md` stands for a chapter
- `article.md` stands for an article
- `task.md` stands for a task (solution must be provided in `solution.md` file as well)
- `index.md` significa um capítulo
- `article.md` significa um artigo
- `task.md` representa uma tarefa (a solução também deve ser fornecida no arquivo `solution.md`)

Each of these files starts from the `# Main header`.
Cada um desses arquivos começa no `# Cabeçalho principal`.

It's very easy to add something new.
É muito fácil adicionar algo novo.

---
Expand Down