mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3cb2d7af0591b12044d4be20dfb6d7f7ff79a4ff
Nim/doc
History
JJ e7e8f437c4 Keep the doc sidebar on the screen while scrolling (#19851) 
* [docgen] Group sidebar sections into <details> (open by default)

* [docgen] Consistent indentation in generated HTML

(this is a boon for working on docgen's html/css output)

* [docgen] Move Source/Edit buttons inside main div

This makes styling the documentation significantly easier.

* [docgen] Somewhat consistent CSS formatting

* [docgen] Keep the sidebar onscreen while scrolling

* [docgen] Tweak CSS for the sticky sidebar

* [docgen] search type=text ==> type=search

* [docgen] Update expected doc output

* [docgen] Fix Group by Type sidebar placement bug

* [docgen] Curse you, whitespace (fix tests)

* [docgen] Fix rst2html tests

Co-authored-by: sandytypical <43030857+xflywind@users.noreply.github.com>
2022-06-15 15:40:56 +02:00
..
manual
turn on syntax highlighting in Manual & Tutorial (#17692)
2021-04-11 10:23:08 +02:00
advopt.txt
Fixed description as option in advopt.txt (#19635)
2022-03-26 09:56:10 +01:00
apis.rst
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
astspec.txt
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
backends.rst
added --nimMainPrefix switch; fixes #15955; refs #16945 [backport:1.6] (#19235)
2021-12-10 14:28:59 +01:00
basicopt.txt
basicopt.txt: Unify the format (#19251)
2021-12-14 09:54:01 +01:00
contributing.rst
clarify how to restart CI (#19845)
2022-06-08 18:17:25 +02:00
destructors.rst
renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)
2021-11-24 15:49:32 +01: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.rst
change os.nim doc links to new style (#19102)
2021-11-08 13:10:01 +01:00
docs.rst
renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)
2021-11-24 15:49:32 +01:00
docstyle.rst
add RST highlighting for command line / shells (also fixes #16858) (#17789)
2021-04-21 16:57:54 +02:00
drnim.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
effects.txt
Nimrod renamed to Nim
2014-08-28 22:36:14 +02:00
estp.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
filelist.txt
follow-up #17837: add Console for interactive sessions (#17930)
2021-05-06 10:58:01 +02:00
filters.rst
change --hint[X] => --hint:X in nim repo (avoids shell quoting issues) (#18085)
2021-05-26 09:51:48 +02:00
grammar.txt
Allow full commands and blocks in type sections (#19181)
2022-01-02 07:29:55 +01:00
hcr.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
idetools.rst
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
2021-03-18 20:37:55 -07:00
intern.rst
Extend and document compiler debugging utilities (#19841)
2022-06-10 20:40:08 +02:00
keywords.txt
language change: 'generic' and 'atomic' are not keywords anymore
2017-11-21 11:27:35 +01:00
koch.rst
Extend and document compiler debugging utilities (#19841)
2022-06-10 20:40:08 +02:00
lib.rst
Add link to std/tempfiles in the docs; fix #19155 (#19807)
2022-05-24 17:53:01 +02:00
manual_experimental_strictnotnil.rst
Fix typo and incorrect pragma name (#19847)
2022-05-30 10:40:15 +08:00
manual_experimental.rst
New/better macro pragmas, mark some as experimental (#19406)
2022-01-20 20:57:50 +01:00
manual.rst
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
mm.rst
renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)
2021-11-24 15:49:32 +01:00
mytest.cfg
'#' value parcing is explained (disambiguated) (#12476)
2019-10-25 15:22:26 +02:00
nep1.rst
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
nimc.rst
nimc.rst: fix table markup (#19239)
2021-12-11 05:15:44 +01:00
nimdoc.cls
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
nimdoc.css
Keep the doc sidebar on the screen while scrolling (#19851)
2022-06-15 15:40:56 +02:00
nimfix.rst
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
2021-03-18 20:37:55 -07:00
nimgrep_cmdline.txt
update nimgrep documentation (#17415)
2021-03-23 18:12:27 +01:00
nimgrep.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
niminst.rst
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
nims.rst
Update nims.rst to reflect that -d:release is now allowed in config.nims (#18221)
2021-06-10 14:29:03 +02:00
nimsuggest.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
overview.rst
further cleanups; refs #4934
2016-10-24 12:20:51 +02:00
packaging.rst
Document how to compile a reproducible build (#18953)
2021-10-06 09:41:42 +02:00
pegdocs.txt
Peg captures get stack-like behavior (#18369)
2021-06-28 12:33:20 +02:00
readme.txt
doc: Trim .txt files trailing whitespace
2015-09-04 23:10:48 +02:00
refc.rst
renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)
2021-11-24 15:49:32 +01:00
regexprs.txt
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
rstcommon.rst
follow-up #17692: more inline syntax highlighting (#17837)
2021-04-29 17:16:14 +02:00
sets_fragment.txt
small improvements for tut1.rst (#17935)
2021-05-05 07:44:33 +02:00
spawn.txt
Change stdlib imports to use std prefix in most examples (#17202)
2021-02-28 13:17:19 -08:00
subexes.txt
more "eg" fixes
2020-10-20 10:51:50 +02:00
testament.rst
Fix default testament target in docs and cli help (#19796)
2022-05-23 06:12:34 +02:00
tools.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
tut1.rst
RST: improve simple tables (#19859)
2022-06-04 07:03:03 +02:00
tut2.rst
Add commas to docs for clarity (#18398)
2021-06-29 19:21:30 -07:00
tut3.rst
fix: Fix introductory macro examples (#19706)
2022-04-09 17:51:44 +02:00

readme.txt 

============================
Nim's documenation system
============================

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