Skip to content

Commit 1462d21

Browse files
committed
Update the docs
1 parent 70c865b commit 1462d21

File tree

5 files changed

+32
-21
lines changed

5 files changed

+32
-21
lines changed

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,15 @@ This folder contains all the content on the website and it is divided into:
2424

2525
1. `/examples`
2626

27-
Examples are divided into category folders and each example has its own folder named like the example with files for every language. The english file is named `index.mdx` and the other languages have their language code before the `.mdx` file type (e.g. `index.de.mdx`). Each example has to have a cover image for the index named liked the example file with a `16:9` ratio (minimum width 288px) and a cover image named `Cover.png\.jpg` for the homepage with 1:1 ratio (minimum width 600px) placed in the same folder.
28-
29-
2. `/tutorials`
30-
31-
Every text tutorial has its own folder named after the tutorial with files for every language. The english file is index.mdx and the other languages have their language code<sup>1</sup> before `.mdx` (e.g. index.de.mdx). All `.mdx` files can use custom MDX Components that are globally available with the following tags:
32-
33-
- `<FixedImage>{image in MDX}</FixedImage>` wraps an image in a container to give it a fixed size. The style can be overriden through the style attribute.
34-
- `<HighlightBlock>{content}</HighlightBlock>` wraps content in a gray block to highlight a block of content.
35-
- `<Intro>{content}</Intro>` changes text styling for the introduction of pages.
36-
- `<Note>{content}</Note>` a small note with smaller font-size for disclaimer of a certain content.
37-
38-
The current tutorials need to be translated from their current format (`.html`) to MDX, see [Table of Components](https://mdxjs.com/table-of-components) for further details.
39-
40-
Each tutorial has a cover image for the index pages that needs to be declared in the header of its .mdx file as a `coverImage` key with the filename of the cover that must be placed in the same folder. This image should have a `3:1` ratio with a minimum width of `600px`.
41-
42-
3. `/books`
27+
3) `/books`
4328

4429
Every book has its own folder with an `.mdx` file that includes the data of the book and a body text description. The cover of the book should be named after the folder.
4530

46-
4. `/tools`
31+
4) `/tools`
4732

4833
The tools are `.json` files that include the name and the description of the tool.
4934

50-
5. `/pages`
35+
5) `/pages`
5136

5237
This folder contains all the singular pages that don't belong to any template. Every page has its own folder and inside that folder, files for every language. The english file is named `index.mdx` and the other languages have their code before `.mdx` (e.g. `index.de.mdx`)
5338

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ This content changes more often, and is often shown in list form. This includes
1717
- [Libraries](/docs/libraries.md)
1818
- [Tools](/docs/tools.md)
1919
- Learn
20-
- [Tutorials](#)
21-
- [Examples](#)
22-
- [Books](#)
20+
- [Tutorials](/docs/tutorials.md)
21+
- [Examples](/docs/examples.md)
22+
- [Books](/docs/markdown-pages.md)
2323
- [Teach](#)
2424
- [About](#)
2525
- [Donate](#)

docs/examples.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Examples
2+
3+
Examples are `.mdx` files that can be edited as explained in the [markdown pages](/docs/markdown-pages.md) guide. However, here's a bit more information that applies specifically to the examples.
4+
5+
## Cover image
6+
7+
Each example has to have a cover image for the index named liked the example file with a `16:9` ratio (minimum width 288px) and a cover image named `Cover.png\.jpg` for the homepage with 1:1 ratio (minimum width 600px) placed in the same folder.

docs/markdown-pages.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ Some pages on the website are created via `.mdx` files. These are traditional ma
55
- Environment (in the [`/content/pages/environment`](/content/pages/environment) folder)
66
- About (in the [`/content/pages/about`](/content/pages/about) folder)
77
- Libraries (in the [`/content/pages/libraries`](/content/pages/libraries) folder. Does not apply to Contributions on the same page)
8+
- Tutorials (in the [`/content/tutorials`](/content/tutorials) folder)
9+
- Examples (in the [`/content/examples`](/content/examples) folder)
10+
- Books (in the [`/content/books`](/content/books) folder)
811

912
## Editing the english version of a page
1013

docs/tutorials.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Tutorials
2+
3+
Tutorials are `.mdx` files that can be edited as explained in the [markdown pages](/docs/markdown-pages.md) guide. However, here's a bit more information that applies specifically to the tutorials.
4+
5+
## Using custom components
6+
7+
All `.mdx` files can use custom React Components that are globally available with the following tags:
8+
9+
- `<FixedImage>{image in MDX}</FixedImage>` wraps an image in a container to give it a fixed size. The style can be overriden through the style attribute.
10+
- `<HighlightBlock>{content}</HighlightBlock>` wraps content in a gray block to highlight a block of content.
11+
- `<Intro>{content}</Intro>` changes text styling for the introduction of pages.
12+
- `<Note>{content}</Note>` a small note with smaller font-size for disclaimer of a certain content.
13+
14+
## Cover images
15+
16+
Each tutorial has a cover image for the index pages that needs to be declared in the header of its `.mdx` file as a `coverImage` key with the filename of the cover that must be placed in the same folder. This image should have a `3:1` ratio with a minimum width of `600px`.

0 commit comments

Comments
 (0)