Nim/doc at b213da99373cb47f0fbb754f44c47394c8ae5553 - Nim

mirror of https://github.com/nim-lang/Nim.git synced 2026-01-01 10:52:14 +00:00

Files

ringabout 11713ef018 remove obselete doc with nimrtl (#23358 )

since nimrtl.dll is created with `--threads:on`

(cherry picked from commit a619434904)

2024-05-21 14:19:04 +02:00

manual

Markdown code blocks part 5 (#20236 )

2022-08-17 15:20:22 -04:00

advopt.txt

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

apis.md

Improve Markdown code blocks & start moving docs to Markdown style (#19954 )

2022-07-15 19:27:54 +02:00

astspec.txt

proc typeclass accounts for iterator, call conventions + nil fix + document typeclass AST (#21629 )

2023-04-11 09:23:41 +02:00

backends.md

fix #21501 by making --app:lib and --app:staticLib imply --noMain (#21910 )

2023-05-26 03:20:56 +02:00

basicopt.txt

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

contributing.md

Tidy contributing.md: format cmd (#22204 )

2023-07-01 16:16:59 +08:00

destructors.md

destructors: better docs [backport:2.0] (#22391 )

2024-04-17 09:36:34 +02:00

docgen_sample.nim

fix #13218 : avoid some irrelevant warnings for nim doc,rst2html,--app:lib, + other fixes (#13550 )

2020-03-13 20:42:41 +01:00

docgen.md

Update nim 2.0 documentation for docgen & nimgrep (#21665 )

2023-04-17 10:57:51 +02:00

docs.md

Markdown link migration part 2 (#20371 )

2022-09-19 18:24:40 -04:00

docstyle.md

Markdown link migration part 2 (#20371 )

2022-09-19 18:24:40 -04:00

drnim.md

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

effects.txt

Markdown code blocks part 4 (#20189 )

2022-08-12 14:33:43 -04:00

estp.md

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

filelist.txt

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

filters.md

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

grammar.txt

type annotations for variable tuple unpacking, better error messages (#22611 )

2024-04-17 14:04:43 +02:00

hcr.md

Markdown code blocks part 4 (#20189 )

2022-08-12 14:33:43 -04:00

idetools.md

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

intern.md

[std/os clean up] import and export osseps (#20580 )

2022-10-17 20:29:00 +02:00

keywords.txt

language change: 'generic' and 'atomic' are not keywords anymore

2017-11-21 11:27:35 +01:00

koch.md

Markdown link migration part 2 (#20371 )

2022-09-19 18:24:40 -04:00

lib.md

Remove the "This module" suffix and reword some entries from the stdlib overview (#21580 )

2023-03-30 15:35:17 +02:00

manual_experimental_strictnotnil.md

fixes strictnotnil documentation; comment unfinished sections (#21041 )

2022-12-08 10:06:48 +08:00

manual_experimental.md

Make typeRel behave to spec (#22261 )

2024-04-18 09:01:14 +02:00

manual.md

fixes a typo in the manual (#22383 )

2024-04-17 09:35:58 +02:00

markdown_rst.md

Update nim 2.0 documentation for docgen & nimgrep (#21665 )

2023-04-17 10:57:51 +02:00

mm.md

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

mytest.cfg

'#' value parcing is explained (disambiguated) (#12476 )

2019-10-25 15:22:26 +02:00

nep1.md

Recommend hanging indent in NEP1 (#23105 )

2024-04-19 16:39:13 +02:00

nimc.md

remove obselete doc with nimrtl (#23358 )

2024-05-21 14:19:04 +02:00

nimdoc.cls

RST: improve simple tables (#19859 )

2022-06-04 07:03:03 +02:00

nimdoc.css

make it printer friendly (#21218 )

2023-01-04 15:10:44 -05:00

nimgrep_cmdline.txt

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

nimgrep.md

nimgrep: fix typo (#21337 )

2023-02-07 16:15:44 +08:00

niminst.md

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

nims.md

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

nimsuggest.md

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

overview.md

Improve Markdown code blocks & start moving docs to Markdown style (#19954 )

2022-07-15 19:27:54 +02:00

packaging.md

fixes #21461 (#21463 )

2023-03-03 23:37:12 +01:00

pegdocs.txt

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

readme.txt

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

refc.md

replaces implicit passes array registed at runtime with explicit function calls; simplify compilation pipeline (#21444 )

2023-03-03 07:36:38 +01:00

regexprs.txt

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

rstcommon.rst

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

sets_fragment.txt

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

spawn.txt

Markdown link migration part 2 (#20371 )

2022-09-19 18:24:40 -04:00

subexes.txt

Markdown code blocks part 5 (#20236 )

2022-08-17 15:20:22 -04:00

testament.md

testament: make valgrind optional (#21238 )

2023-01-11 12:23:43 -05:00

tools.md

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

tut1.md

Markdown indented code blocks (#20473 )

2022-10-05 14:03:10 -04:00

tut2.md

fix #19580 ; add warning for bare except: clause (#21099 )

2022-12-15 06:45:36 +01:00

tut3.md

clean up the documentation (#22196 )

2023-07-02 22:36:05 +02:00

readme.txt

============================
Nim's documentation system
============================

This folder contains Nim's documentation. The documentation
is written in a format called *Markdown*, a markup language that reads
like ASCII and can be converted to HTML automatically!