Skip to content

Commit

Permalink
Fix note in getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
Caleb-o committed Sep 21, 2024
1 parent d67f5fe commit 78ae595
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 18 deletions.
16 changes: 16 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,22 @@ <h1 id="document-not-found-404"><a class="header" href="#document-not-found-404"

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



Expand Down
16 changes: 16 additions & 0 deletions docs/basics/hello_world.html
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,22 @@ <h3 id="explaining-our-program"><a class="header" href="#explaining-our-program"

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



Expand Down
24 changes: 20 additions & 4 deletions docs/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,10 @@ <h1 id="getting-started"><a class="header" href="#getting-started">Getting Start
<p><a href="https://github.com/Caleb-o/c3-cookbook/stargazers"><img src="https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&amp;color=#30a14e" alt="" /></a></p>
<p><em>"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."</em></p>
<h2 id="about-this-book"><a class="header" href="#about-this-book">About this book</a></h2>
<div class="warning">
This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the [latest](https://github.com/c3lang/c3c/releases/tag/latest) compiler.
</div>
<blockquote>
<p>This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the <a href="https://github.com/c3lang/c3c/releases/tag/latest">latest</a> compiler.</p>
</blockquote>
<p>This was inspired by the <a href="https://github.com/zigcc/zig-cookbook">Zig Cookbook</a> which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.</p>
<p>I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.</p>
<p>Since I'm writing this as a newbie to C3, there are bound to be issues or better ways to achieve things.</p>
Expand Down Expand Up @@ -229,6 +229,22 @@ <h2 id="editors--tooling"><a class="header" href="#editors--tooling">Editors / T

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



Expand Down
24 changes: 20 additions & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,10 @@ <h1 id="getting-started"><a class="header" href="#getting-started">Getting Start
<p><a href="https://github.com/Caleb-o/c3-cookbook/stargazers"><img src="https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&amp;color=#30a14e" alt="" /></a></p>
<p><em>"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."</em></p>
<h2 id="about-this-book"><a class="header" href="#about-this-book">About this book</a></h2>
<div class="warning">
This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the [latest](https://github.com/c3lang/c3c/releases/tag/latest) compiler.
</div>
<blockquote>
<p>This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the <a href="https://github.com/c3lang/c3c/releases/tag/latest">latest</a> compiler.</p>
</blockquote>
<p>This was inspired by the <a href="https://github.com/zigcc/zig-cookbook">Zig Cookbook</a> which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.</p>
<p>I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.</p>
<p>Since I'm writing this as a newbie to C3, there are bound to be issues or better ways to achieve things.</p>
Expand Down Expand Up @@ -229,6 +229,22 @@ <h2 id="editors--tooling"><a class="header" href="#editors--tooling">Editors / T

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



Expand Down
24 changes: 20 additions & 4 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,10 @@ <h1 id="getting-started"><a class="header" href="#getting-started">Getting Start
<p><a href="https://github.com/Caleb-o/c3-cookbook/stargazers"><img src="https://img.shields.io/github/stars/Caleb-o/c3-cookbook?style=square&amp;color=#30a14e" alt="" /></a></p>
<p><em>"C3 is a programming language that builds on the syntax and semantics of the C language, with the goal of evolving it while still retaining familiarity for C programmers."</em></p>
<h2 id="about-this-book"><a class="header" href="#about-this-book">About this book</a></h2>
<div class="warning">
This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the [latest](https://github.com/c3lang/c3c/releases/tag/latest) compiler.
</div>
<blockquote>
<p>This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the <a href="https://github.com/c3lang/c3c/releases/tag/latest">latest</a> compiler.</p>
</blockquote>
<p>This was inspired by the <a href="https://github.com/zigcc/zig-cookbook">Zig Cookbook</a> which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.</p>
<p>I have used new languages where documentation and community driven media was scarce, which made it very hard to get an understanding of the language in a more practical manner. Hopefully this book can help with this issue and get some more people into C3.</p>
<p>Since I'm writing this as a newbie to C3, there are bound to be issues or better ways to achieve things.</p>
Expand Down Expand Up @@ -301,6 +301,22 @@ <h3 id="explaining-our-program"><a class="header" href="#explaining-our-program"

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@

## About this book

<div class="warning">
This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
If an example doesn't quite work with 0.6.2, try using the [latest](https://github.com/c3lang/c3c/releases/tag/latest) compiler.
</div>

> This book is being written with 0.6.x in mind. It may include nightly releases that have fixed problems with 0.6.2.
> If an example doesn't quite work with 0.6.2, try using the [latest](https://github.com/c3lang/c3c/releases/tag/latest) compiler.
This was inspired by the [Zig Cookbook](https://github.com/zigcc/zig-cookbook) which displays common and more idiomatic ways to use Zig around certain problems. I wanted to create a community driven book, that would do the same for C3. I believe it is something that can help developers pickup C3, as it provides another source to browse.

Expand Down

0 comments on commit 78ae595

Please sign in to comment.