Nim/doc at 86d6f71f5afd03ce372ee89b348797f43899579a - Nim

mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00

Files

Jake Leahy 86d6f71f5a Doc search improvements (#24567 )

- `/` is now a hotkey to jump to the search
- Search results now are in line with the page (previously on small
screens it would be off centre)
- Jumping to a search result inside the page or via TOC will now hide
the search results (previously the results got in the way)

Example site here: https://tranquil-scone-c159b6.netlify.app/main.html

2024-12-25 14:19:22 +01:00

manual

Markdown code blocks part 5 (#20236 )

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

advopt.txt

track call depth separately from loop count in VM (#24512 )

2024-12-06 19:00:59 +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

prefix NimDestroyGlobals with nimMainPrefix (#24493 )

2024-12-03 13:05:14 +08: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

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

2023-08-05 19:35:37 +02:00

docgen_sample.nim

complete std prefixes for stdlib (#22887 )

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

docgen.md

documentation and comments use HTTPS when possible (#24264 )

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

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

Fixes #23085 : update grammars for 'concept' (#23256 )

2024-01-26 08:03:41 +01:00

hcr.md

documentation and comments use HTTPS when possible (#24264 )

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

move "Strict definitions and out parameters" to the manual (#24474 )

2024-11-25 15:55:25 +01:00

manual.md

move "Strict definitions and out parameters" to the manual (#24474 )

2024-11-25 15:55:25 +01:00

markdown_rst.md

doc: fix typos (#22869 )

2023-10-25 20:53:15 +08: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

documentation and comments use HTTPS when possible (#24264 )

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

nimdoc.cls

RST: improve simple tables (#19859 )

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

nimdoc.css

Doc search improvements (#24567 )

2024-12-25 14:19:22 +01: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

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

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

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

#22514 expand testament option docs (#22516 )

2023-08-19 17:25:38 +02:00

tools.md

clean up the documentation (#22196 )

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

tut1.md

Expand enum example tut1.md (#24268 )

2024-10-13 07:00:23 +02:00

tut2.md

fix typo: "As can been seen" to "As can be seen" (#23544 )

2024-04-28 12:36:51 +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!