Update README.md

This commit is contained in:
Ilya Kantor 2017-01-17 12:32:43 +01:00 committed by GitHub
parent 6c9c2219ba
commit d6bbbfe8f0

View file

@ -1,17 +1,15 @@
# The JavaScript Tutorial # The JavaScript Tutorial
This repository hosts the content of the JavaScript Tutorial, to be available on [https://javascript.info](https://javascript.info). This repository hosts the content of the JavaScript Tutorial, published at [https://learn.javascript.info](https://learn.javascript.info).
The backend is written using [node.js](https://nodejs.org). It is in the separate repo: [https://github.com/iliakan/javascript-tutorial-server](https://github.com/iliakan/javascript-tutorial-server), here is the text only.
Please use this repository to file issues and suggest PRs for the text. Please use this repository to file issues and suggest PRs for the text.
## Structure ## Structure
Every chapter, article or task has it's folder. Every chapter, article or a task has its folder.
The folder has the name `N-url`, where `N` is a number for the sorting and `url` — is the URL-address for the material. The folder has the name `N-url`, where `N` is a number for the sorting and `url` — is the URL-name for the material.
The kind of the material is defined by the file inside the folder: The kind of the material is defined by the file inside the folder:
@ -21,6 +19,4 @@ The kind of the material is defined by the file inside the folder:
Each of these files starts from the `# Main header`. Each of these files starts from the `# Main header`.
Assets required for the material are in it's folder and can be referenced from the file. Assets required for the material reside in the same folder.
For example, an `image.png` for the article should be in it's folder and accessed as `<img src="image.png">` from it's `article.md` file.