Skip to content

Commit

Permalink
updated: simplify the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GianlucaGuarini committed Dec 8, 2023
1 parent bd5187c commit 47c377a
Show file tree
Hide file tree
Showing 6 changed files with 2,204 additions and 1,007 deletions.
28 changes: 3 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Create tests for your examples. This is so we can ensure they don't break when f

Please make sure to use always the latest riot releases:

- [riot+compiler.min.js](https://rawgit.com/riot/riot/master/riot%2Bcompiler.min.js)
- [riot.js](https://cdn.rawgit.com/riot/riot/master/riot.min.js)
- [riot+compiler.min.js](https://rawgit.com/riot/riot/main/riot%2Bcompiler.min.js)
- [riot.js](https://cdn.rawgit.com/riot/riot/main/riot.min.js)

For all the other libraries use either [jsdelivr.com](https://www.jsdelivr.com/) or [cdnjs](https://cdnjs.com/)
For all the other libraries use [unpkg.com](https://www.unpkg.com)

### Folder structure

Expand All @@ -29,26 +29,4 @@ Please follow the standard set by the other examples by using this folder struct

Not all of these are required, it will differ between examples.

### Coding Guidelines

Follow the coding style established in the rest of the codebase.

**Semicolons**<br>
[No](http://blog.izs.me/post/2353458699/an-open-letter-to-javascript-leaders-regarding)
[semicolons](http://inimino.org/~inimino/blog/javascript_semicolons),
[please](https://www.youtube.com/watch?v=gsfbh17Ax9I)!

**Spacing**<br>
Use two spaces for indentation. No tabs.
Spacing around brackets: `if (foo) {` instead of `if(foo){`

**Quotes**<br>
Single-quoted strings are preferred to double-quoted strings.

**Equality Checking**<br>
Prefer `==` over `===` unless it's a must.

**Bitwise Operations**<br>
Prefer classic conditionals `i < 0` over bitwise operators `!~pos`

#### We are happy to accept PRs so thank you in advance!
2 changes: 1 addition & 1 deletion modal/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<cool-modal></cool-modal>

<script type="text/javascript" src="https://unpkg.com/riot@9/riot+compiler.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@riotjs/observable@4/dist/observable.min.js"></script>
<script src="https://unpkg.com/@riotjs/observable@4.1.1/dist/observable.js"></script>
<script type="riot" src="./modal.riot"></script>
<script type="riot" src="./cool-modal.riot"></script>

Expand Down
12 changes: 10 additions & 2 deletions riot-config/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,20 @@
<head>
<title>Riot with next standards</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<script type="importmap">
{
"imports": {
"riot": "https://unpkg.com/riot@9/esm/riot.js"
}
}
</script>

</head>

<body>
<div id="root"></div>
<script src="https://cdn.jsdelivr.net/npm/riot@5/riot.js"></script>
<script src="dist/main.js"></script>
<script src="https://unpkg.com/riot@9/riot+compiler.min.js"></script>
<script type="module" src="dist/main.js"></script>
</body>

</html>
Loading

0 comments on commit 47c377a

Please sign in to comment.