writing-guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| writing-guide [May 25, 2026 at 13:23] – Ivan Janevski | writing-guide [June 11, 2026 at 00:00] (current) – removed Ivan Janevski | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | # Writing guide | ||
| - | Every article should preferably start with '#' | ||
| - | ## Subsections | ||
| - | Sections should have a certain flavor. For example, if a section is titled "List of concepts related to X" it should only contain a list, not. Similarily, if a section is titled "C++ code illustrating X" | ||
| - | |||
| - | The first section should preferably always start with a paragraph that starts with the name of the article in **bold** followed by a short description (two-three sentences) of what the concept is. The subsequent paragraphs should expand the concept in the most nautral way. | ||
| - | |||
| - | ## Code block | ||
| - | A code block is a larger piece of code that | ||
| - | |||
| - | ```cpp | ||
| - | // Compile: g++ main.c -o main | ||
| - | // Run: | ||
| - | |||
| - | #include < | ||
| - | |||
| - | int main() | ||
| - | { | ||
| - | printf(" | ||
| - | return 0; | ||
| - | } | ||
| - | |||
| - | ``` | ||
writing-guide.1779715416.txt.gz · Last modified: by Ivan Janevski
