LogoLogo
  • V by Example
  • en
    • examples
      • section_3
        • Functions
        • Methods
        • Arrays
        • Struct
      • section_1
        • Primitives
        • Keywords
        • Variables
        • Formatted Print
        • Strings
        • Comments
      • section_4
        • Files
        • JSON
        • Testing
        • Array Functions
      • section_2
        • Operators
        • Looping Constructs
        • If statement
        • Match
  • V por exemplos
    • Contribuindo
    • examples
      • section_1
        • Comentários
        • Primitivos
        • Palavras-chave
      • section_2
        • Operadores
  • V mit einem Beispiel
    • examples
      • section_3
        • Methods
        • Struct
        • Functions
        • Arrays
      • section_4
        • Testing
        • Array Functions
        • JSON
        • Files
      • section_2
        • Looping Constructs
        • If statement
        • Match
        • Operators
      • section_1
        • Primitive Datentypen
        • Schlüsselwörter
        • Formatted Print
        • Strings
        • Kommentare
        • Variables
    • CONTRIBUTING_de
  • V dengan Contoh
    • examples
      • section1
        • Variabel
  • 通过例子学V语言
    • 例子
      • section_3
        • 函数
        • 方法
        • 数组
        • 结构体
      • section_1
        • 基本类型
        • 关键字
        • 变量
        • print系列函数
        • 字符
        • 注释
      • section_4
        • 文件
        • JSON操作
        • 调试
        • 数组函数
      • section_2
        • 运算符
        • 循环结构
        • If表达式
        • 匹配
  • コード例で学ぶV言語
    • examples
      • section_3
        • 関数
        • メソッド
        • 配列
        • 構造体
      • section_1
        • プリミティブ型
        • キーワード
        • 変数
        • 書式付き出力
        • 文字列
        • コメント
      • section_4
        • ファイル操作
        • JSON操作
        • テスト
        • 配列の関数
      • section_2
        • 演算子
        • ループ
        • If文
        • マッチ
  • Changelog
  • Contributing
  • Documentation Style Guide
Powered by GitBook
On this page
  • Titles
  • Print Width
  • Code Output
  • Indentation

Was this helpful?

Documentation Style Guide

These are the guidelines for writing documentation.

Titles

  • Each page must have a single #-level title at the top.

  • Chapters in the same page must have ##-level titles.

  • Sub-chapters need to increase the number of # in the title according to

    their nesting depth.

  • All words in the page's title must be capitalized, except for conjunctions

    like "of" and "and" .

  • Only the first word of a chapter title must be capitalized.

# Arrays

...

## How to declare an array

...

## Create an empty array

...

Print Width

To be easy to read when editing the markdown code, if the sentence is too long, divide it down. The recommended column length limit is 80.

Code Output

To create output from code, there are two rules:

  • If the output is short then put it as a comment

  • If the output is quite long (column) then write it in a separate section after the code section.

Indentation

Indentation must use spaces and the tab size must be 4.

PreviousContributing

Last updated 5 years ago

Was this helpful?