summary refs log tree commit diff stats
path: root/doc/nims.rst
Commit message (Collapse)AuthorAgeFilesLines
* Improve Markdown code blocks & start moving docs to Markdown style (#19954)Andrey Makarov2022-07-151-345/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - add additional parameters parsing (other implementations will just ignore them). E.g. if in RST we have: .. code:: nim :test: "nim c $1" ... then in Markdown that will be: ```nim test="nim c $1" ... ``` - implement Markdown interpretation of additional indentation which is less than 4 spaces (>=4 spaces is a code block but it's not implemented yet). RST interpretes it as quoted block, for Markdown it's just normal paragraphs. - add separate `md2html` and `md2tex` commands. This is to separate Markdown behavior in cases when it diverges w.r.t. RST significantly — most conspicously like in the case of additional indentation above, and also currently the contradicting inline rule of Markdown is also turned on only in `md2html` and `md2tex`. **Rationale:** mixing Markdown and RST arbitrarily is a way to nowhere, we need to provide a way to fix the particular behavior. Note that still all commands have **both** Markdown and RST features **enabled**. In this PR `*.nim` files can be processed only in Markdown mode, while `md2html` is for `*.md` files and `rst2html` for `*.rst` files. - rename `*.rst` files to `.*md` as our current default behavior is already Markdown-ish - convert code blocks in `docgen.rst` to Markdown style as an example. Other code blocks will be converted in the follow-up PRs - fix indentation inside Markdown code blocks — additional indentation is preserved there - allow more than 3 backticks open/close blocks (tildas \~ are still not allowed to avoid conflict with RST adornment headings) see also https://github.com/nim-lang/RFCs/issues/355 - better error messages - (other) fix a bug that admonitions cannot be used in sandbox mode; fix annoying warning on line 2711
* Update nims.rst to reflect that -d:release is now allowed in config.nims ↵Kaushal Modi2021-06-101-6/+6
| | | | | (#18221) `-d:release` and `-d:danger` started working in `config.nims` after https://github.com/nim-lang/Nim/commit/df429fa28772e077faa30dd6e3a701abf48c7669 .
* follow-up #18013 - inline syntax highlighting (#18166)Andrey Makarov2021-06-041-22/+23
|
* RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) ↵quantimnot2021-03-181-38/+40
| | | | | (#17258) Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* promote std prefix in docs (#17128)flywind2021-02-201-1/+1
|
* Fixing unexistant word in PT (#17070)KioriSun2021-02-171-1/+1
| | | | In line 289 it said PT =minino for cat. Cat in Portugues is Gato, like in spanish. minino sounds like a foreigner trying to pronounce menino, which means boy, not cat. For variation's sake, my suggestion is to use the italian(IT) version Gatto, since it keeps in line with being close to ES, alternatively the german(DE) version Katze could be used instead.
* Documentation update nims.rst (#14683)Juan Carlos2020-06-171-0/+13
| | | | | * Update nims.rst to add modules that work on NimScript as mentioned in the changelog.md * https://github.com/nim-lang/Nim/pull/14683#issuecomment-644976921
* StringStream & more stdlib modules support for JS/NimScript (#14095)hlaaftana2020-04-281-2/+0
| | | | | * StringStream & more stdlib modules support for JS/NimScript * change back pegs test in line with #14134
* [other] Documentation NimScript (#11548)Juan Carlos2019-06-231-8/+172
| | | | | * Documentation of NimScript, update and expand, mention the benefits aside of its limitations, add examples, update the list of usable std lib modules
* docs: minor subjective improvementAraq2019-05-051-2/+2
|
* Run nimscript without "nim e" (#11121)Federico Ceratto2019-05-041-1/+5
| | | | Add a link to nimscript.rst Add a suggestion on disabling hints.
* setCommand nop update documentation (#10254)Strømberg2019-01-131-11/+0
| | | When I used Warning: Using `setCommand 'nop'` is not necessary.
* Added 'Limitations' section to nimscript manual listing the restrictions of ↵Ico Doornekamp2019-01-101-3/+22
| | | | the VM (#10209)
* Fixes #9671 (#9750)Randy Smith2018-11-191-1/+1
|
* Update config.nims search path in docs (#9388)Kaushal Modi2018-10-171-3/+20
| | | | | Related: https://github.com/nim-lang/Nim/pull/8682 Also mention the "nim help" command to list all available tasks.
* Fix RST formatting; reword a notice about -d:release in .nimsKaushal Modi2018-09-251-3/+5
|
* Remove nim.cfg mentions from NimScript (nims) docsKaushal Modi2018-09-241-18/+35
| | | | | | | | | | | Other changes: - Add macros module to the list of modules that can be imported in .nims files. - Use "<myproject>" instead of "myproject" so that it looks more like a project name placeholder. - Mention that switch proc cannot be used to set -d:release in NimScripts.
* Documented shebang execution of NimscriptsAdam Johnson2017-05-211-0/+9
|
* added distros.nim stdlib module for NimScript/Nimble supportAraq2016-12-311-0/+5
|
* Fix inaccuracy surrounding Nimble in doc/nims.rst.Dominik Picheta2016-11-211-16/+2
|
* renamed most remaining .txt documentation files to .rstAraq2016-06-071-0/+119