Nim/doc at b60a03a2beb00b1657cd3be07cdb7a1acb7e0731 - Nim

mirror of https://github.com/nim-lang/Nim.git synced 2026-06-14 23:53:47 +00:00

Files

Araq d269ccff26 IC: correct instance-name format in design doc

The content key is hashed into <disamb> (setInstanceDisamb), not a separate
.key. token; document that the cross-TU merge and DCE already key on the
module-suffix-stripped name.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-06-13 20:28:43 +02:00

manual

Markdown code blocks part 5 (#20236 )

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

advopt.txt

Raw switch for jsondoc (#24568 )

2026-01-11 18:39:01 +08:00

apis.md

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

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

astspec.txt

complete std prefixes for stdlib (#22887 )

2023-10-30 17:03:04 +01:00

backends.md

docs: fix typos (#24573 )

2024-12-27 19:42:18 +01:00

basicopt.txt

Markdown indented code blocks (#20473 )

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

contributing.md

docgen: add Pandoc footnotes (fixes #21080 ) (#22591 )

2023-09-03 16:09:36 +02:00

destructors.md

undeprecates var T destructors (#24716 )

2025-02-25 17:05:59 +01:00

docgen_sample.nim

complete std prefixes for stdlib (#22887 )

2023-10-30 17:03:04 +01:00

docgen.md

nimdoc: Document environment variable substitution (#25623 )

2026-03-23 13:00:55 +01: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

complete std prefixes for stdlib (#22887 )

2023-10-30 17:03:04 +01: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

parser: concept of (#25878 )

2026-06-08 11:32:04 +02:00

hcr.md

documentation and comments use HTTPS when possible (#24264 )

2024-10-08 21:50:35 +02:00

ic.md

IC: correct instance-name format in design doc

2026-06-13 20:28:43 +02:00

idetools.md

Markdown indented code blocks (#20473 )

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

intern.md

Documentation only (#22761 )

2023-09-27 05:49:17 +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

fix link to jsfetch stdlib (#23203 )

2024-01-12 20:50:20 +08:00

manual_experimental_strictnotnil.md

fixes strictnotnil documentation; comment unfinished sections (#21041 )

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

manual_experimental.md

Fix a few typos (#25563 )

2026-02-28 22:50:37 +01:00

manual.md

fix: duplicated words in manual.md and gc_common.nim comment (#25812 )

2026-05-14 08:02:11 +02:00

markdown_rst.md

Fix a few typos (#25563 )

2026-02-28 22:50:37 +01:00

mm.md

Revert "Document move limitations" (#23778 )

2024-07-01 13:06:09 +02:00

mytest.cfg

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

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

nep1.md

documentation and comments use HTTPS when possible (#24264 )

2024-10-08 21:50:35 +02:00

nimc.md

Add heaptrack support (#25257 )

2025-11-06 17:33:52 +01:00

nimdoc.cls

RST: improve simple tables (#19859 )

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

nimdoc.css

nimdoc: CSS: tighter on mobile; fix h1 print page break (#25607 )

2026-03-23 13:00:07 +01:00

nimgrep_cmdline.txt

Fix a few typos (#25563 )

2026-02-28 22:50:37 +01:00

nimgrep.md

nimgrep: fix typo (#21337 )

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

niminst.md

documentation and comments use HTTPS when possible (#24264 )

2024-10-08 21:50:35 +02:00

nims.md

sort modules and added std/setutils (#24168 )

2024-09-26 06:29:25 +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

Fix a few typos (#25563 )

2026-02-28 22:50:37 +01:00

pegdocs.txt

Fix std/pegs sequence example (#25562 )

2026-02-28 17:26:44 +08: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

documentation and comments use HTTPS when possible (#24264 )

2024-10-08 21:50:35 +02: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

fix doc format: testament.md (#24654 )

2025-01-30 18:05:51 +01:00

tools.md

clean up the documentation (#22196 )

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

tut1.md

Update outdated string representation in example (#25802 )

2026-05-09 08:55:39 +02:00

tut2.md

fixes vtable documentation in tut2 (#24304 )

2025-10-15 08:22:27 +02:00

tut3.md

Adds an example of using ident to name procedures to the macros tutorial (#22973 )

2024-09-09 11:46:48 +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!