forked from javascript-tutorial/az.javascript.info
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
42 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
|
||
# Authoring | ||
|
||
This describes important stuff about authoring new articles of the tutorial. | ||
|
||
## Internal links | ||
|
||
All tutorial links should start from the root, not including the domain. | ||
|
||
✅ OK: | ||
|
||
```md | ||
We'll cover that in the chapter [about functions](/function-basics) | ||
``` | ||
|
||
❌ Not ok: | ||
|
||
```md | ||
We'll cover that in the chapter [about functions](https://javascript.info/function-basics) | ||
``` | ||
|
||
Also, to reference a chapter, there's a special "info:" scheme, like this: | ||
|
||
```md | ||
We'll cover that in the chapter <info:function-basics>. | ||
``` | ||
|
||
Becomes: | ||
```html | ||
We'll cover that in the chapter <a href="/function-basics">Function basics</a>. | ||
``` | ||
|
||
The title is auto-inserted from the referenced article. That has the benefit of keeping the right title if the article gets renamed. | ||
|
||
## TODO | ||
|
||
Ask @iliakan to for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters