diff options
Diffstat (limited to 'web/documentation.rst')
-rw-r--r-- | web/documentation.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/web/documentation.rst b/web/documentation.rst new file mode 100644 index 000000000..ec33d0827 --- /dev/null +++ b/web/documentation.rst @@ -0,0 +1,70 @@ +Nim's Documentation +=================== + +.. container:: standout + + Search Options + -------------- + + .. container:: internals + + `Documentation Index <docs/theindex.html>`_ - The generated + index. **Index + (Ctrl+F) == Joy** + +.. container:: standout + + Standards & Guides + ------------------ + + .. container:: libraries + + - | `Standard Library <docs/lib.html>`_ + | This document describes Nim's standard library. + + - | `Language Manual <docs/manual.html>`_ + | The Nim manual is a draft that will evolve into a proper specification. + + - | `Nim Style Guide <docs/nep1.html>`_ + | The stylistic conventions that Nim's official projects adhere to. + + - | `Compiler User Guide <docs/nimc.html>`_ + | The user guide lists command line arguments, special features of the + compiler, etc. + + - | `NimScript <docs/nims.html>`_ + | NimScript is the upcoming new way to configure Nim. + + - | `Nim Backend Integration <docs/backends.html>`_ + | The Backend Integeration guide gives further information of how Nim can + interact with C, C++, Objective C and JavaScript. + + +.. container:: standout + + Tools & Features + ---------------- + + .. container:: tools + + - | `Source Code Filters <docs/filters.html>`_ + | The Nim compiler supports source code filters as a simple yet powerful + builtin templating system. + + - | `Tools Documentation <docs/tools.html>`_ + | Description of some tools that come with the standard distribution. + + +.. container:: standout + + Internal Details + ---------------- + + .. container:: internals + + - | `Garbage Collector <docs/gc.html>`_ + | Additional documentation about Nim's GC and how to operate it in a + realtime setting. + + - | `Internal Documentation <docs/intern.html>`_ + | The internal documentation describes how the compiler is implemented. + Read this if you want to hack the compiler. |