Commit graph

237 commits

Author SHA1 Message Date
Simon Hausmann
163625fcd3 C++ docs: finish re-organzing the C++ docs entry
Instead of repeating the table of contents, provide a proper intro
page - based on the Github README - and group the remaining content
into Getting Started, Reference and Integration sections.
2021-07-10 08:13:13 +02:00
Simon Hausmann
be47f708d9 Cleanup: Move docs/html to docs/resources 2021-07-08 07:01:51 +02:00
Simon Hausmann
6d964b9ee7 Switch highlightjs version
Use the latest version that's also hosted on sixtyfps.io
2021-07-08 07:01:51 +02:00
Simon Hausmann
7cc915ed8e Add sub resource integrity hashes for the CDN urls 2021-07-08 07:01:51 +02:00
Simon Hausmann
dd73852124 Make use of highlight.js self-contained
* Instead of relying on an unversioned url off of sixtyfps.io,
  pin the version from upstream's CDN.
* Include cmake highlighting as well since that's not in HLJS' default,
  we use it for the tutorial though and it was in the one hosted on
  sixtyfps.io
* Include the language definition for .60 inline, so that we can make changes
  and adapt to upstream API changes if we select a new version.
2021-07-08 07:01:51 +02:00
Simon Hausmann
ad321c7735 Use one shared html file for the syntax highlighting
Using Olivier's idea to check the meta tag, we can distinguish rustdoc
from "the rest". The html is included in mdbook by directly by
symlinking head.hbs.
2021-07-08 07:01:51 +02:00
Simon Hausmann
8003c06f3a Move all HTML/CSS/JS related to preview and syntax highlighting in the docs into a shared folder
This will also be the place where the .60 language definition for
highlight.js can go.
2021-07-08 07:01:51 +02:00
Simon Hausmann
77898796da Rust docs: Split up the preview from the syntax highlighting
The preview is now in sixtyfps-docs-preview.html and the highlighting in
sixtyfps-docs-highlight.html. This faciliates reusing the preview from
C++ while using a different HTML file later for syntax highlighting.

Relates to #282
Needed for #281
2021-07-07 14:00:04 +02:00
Tobias Hunger
39984b27db Janitor: Fix spelling in comments 2021-07-03 15:49:43 +02:00
Olivier Goffart
13bd828b96 Update license date 2021-07-02 15:55:54 +02:00
Simon Hausmann
317111ef2b Small drive-by typo fixes 2021-07-01 10:31:36 +02:00
Olivier Goffart
423656d900 Update some more version number
Meaning that following the docs or tutorial won't work until the release is complete
2021-06-30 17:21:38 +02:00
Simon Hausmann
8a2b665498 Remove the note about nightly Rust again
Those who use nightly know likely what they're doing :-)
2021-06-30 11:27:27 +02:00
Simon Hausmann
5614f4c4c8 Mention minimum requirements for macOS
Unfortunately we require cmake right now, due to fontkit wanting to compile
in a copy of freetype. That could be fixed though by making it use
ttf_parser perhaps.
2021-06-30 11:27:27 +02:00
Olivier Goffart
b5f2bbe8bb Mark code fragment as ignored in langref.md
With the nightly rust compiler, we include the langref.md in the
rust documentation, but we don't want these snippets to be understood
as rust code and tested
2021-06-30 09:23:57 +02:00
Simon Hausmann
ce8f5bda24 Mention additional basic Linux dependencies 2021-06-29 22:58:36 +02:00
Simon Hausmann
5b474ecac9 Recommend the use of stable over nightly :-) 2021-06-29 22:56:04 +02:00
Tobias Hunger
e01bd87df8 Janitor: Fix warnings about markdown files
These might change the layout of the rendered markdown files. This will
also fix some typos along the way:-)
2021-06-28 08:32:25 +02:00
Tobias Hunger
13d7f5e7bd Janitor: Fix typos in comments and user-facing strings
Also adapt tests for error messages containing the fixed strings.

No behavior change is intended!
2021-06-28 08:32:25 +02:00
Tobias Hunger
a46d936d6f Janitor: Fix typo in target CMake target name
No behavior change is intended here!
2021-06-28 08:32:00 +02:00
Olivier Goffart
962dc0075c Layout: Make the default padding and spacing 0
and add Box widgets that have proper defaults

Closes #200
2021-06-21 14:29:53 +02:00
Olivier Goffart
99c140ae08 Allow accessing the width and height of the image in .60
Closes #208
2021-06-21 11:22:50 +02:00
Olivier Goffart
42c25248a8 Allow to give a name to for and if 2021-06-18 16:40:40 +02:00
Simon Hausmann
3c76206d7f Share the "dev" readme for the tutorials 2021-06-17 16:18:36 +02:00
Simon Hausmann
ef36caad88 C++ tutorial: Fix code formatting
... to avoid a horizontal scrollbar in the code block.

Apply the same formatting tricks as on the HTML blog version
2021-06-17 16:09:59 +02:00
Simon Hausmann
82403c120b Fix license check 2021-06-17 15:54:40 +02:00
Simon Hausmann
1e7aec1531 C++ tutorial: Remove inline source for the game logic chapter 2021-06-17 15:53:48 +02:00
Simon Hausmann
4affbf728d C++ tutorial: Remove inline sources from the creating tiles from C++ chapter 2021-06-17 15:47:32 +02:00
Simon Hausmann
6e4da0c14e C++ tutorial: Remove use of xml entities 2021-06-17 15:35:47 +02:00
Simon Hausmann
57d25c6d9b C++ tutorial: Remove inline code for the memory tile chapter 2021-06-17 15:34:28 +02:00
Simon Hausmann
031acd77d3 C++ tutorial: Remove inline source in getting start 2021-06-17 15:30:44 +02:00
Simon Hausmann
c540cbaf2d Replace inline .60 code in game logic in $lang chapter 2021-06-17 15:19:09 +02:00
Simon Hausmann
56e56f7028 Fix HTML tag in rust tutorial 2021-06-17 15:13:25 +02:00
Simon Hausmann
4ee7f6e793 Share the ideas-for-the-header chapter between Rust and C++
Use a symlink :-)
2021-06-17 14:21:15 +02:00
Simon Hausmann
310a437b88 Add missing manual syntax highlights
A few more spotted in the original HTML
2021-06-17 14:00:55 +02:00
Simon Hausmann
cc8da495ae Fix CMake syntax highlighting in the C++ tutorial
Use a version of highlight.js from our website that has CMake support
built-in, the one that comes with mdbook doesn't.
2021-06-17 13:47:46 +02:00
Simon Hausmann
59ebc94e71 Synchronize tutorial intro with blog
I really don't know how the last sentence got in, can't find it anywhere.
But now it's in sync with the blog :)
2021-06-17 13:03:49 +02:00
Simon Hausmann
8083046e1d Initial port of the C++ version of the memory tutorial
A couple of things still need to be done though, including more sharing with
the Rust version, cmake syntax highlighting, externalizing the code.
2021-06-17 11:53:16 +02:00
Olivier Goffart
0299ad66c8 Add publish=false to tutorial's Cargo.toml 2021-06-17 11:23:58 +02:00
Simon Hausmann
9ff3dabe7e Fix license header check 2021-06-17 11:11:45 +02:00
Simon Hausmann
7b95371c78 Move the Rust tutorial into a sub-directory
To make room for the C++ version next to it :-)
2021-06-17 11:04:43 +02:00
Simon Hausmann
a012809bd0 Re-apply manual syntax highlights
Those were also applied in the HTML version
2021-06-17 10:59:49 +02:00
Simon Hausmann
f02f091ac6 Add one more noplayground attribute
Forgot this one in the previous commit :-)
2021-06-17 10:47:40 +02:00
Simon Hausmann
9f11d3d126 Disable the playground buttons in the Rust tutorial
Running those requires sixtyfps and graphics. Would be cool of course to
have a wasm based playground in the future, but meanwhile it's better to
disable the buttons.
2021-06-17 10:46:48 +02:00
Simon Hausmann
a31e7e4220 Allow testing the individual Rust tutorial steps by hand
Might be useful for regression testing
2021-06-17 10:37:48 +02:00
Simon Hausmann
d9d580bbdf Fix .60 markup in step from one to multiple tiles 2021-06-16 15:44:37 +02:00
Simon Hausmann
5864411eca Extract all .60 code in the rust tutorial into separate files
That gives maximum test coverage
2021-06-16 14:45:18 +02:00
Simon Hausmann
573638c228 Include the icons as well in the .60 markup for the tests 2021-06-16 13:37:54 +02:00
Simon Hausmann
8bc8767e17 Test the tutorial Rust code in doctests
This implicitly also "tests" the .60 code since we're using the macro
2021-06-16 13:35:16 +02:00
Simon Hausmann
ea9548c207 Fix license header check 2021-06-16 08:51:24 +02:00