Commit graph

21 commits

Author SHA1 Message Date
Andrey Makarov
417b90a7e5
Improve Markdown code blocks & start moving docs to Markdown style (#19954)
- 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
2022-07-15 19:27:54 +02:00
Kaushal Modi
3481ff6172
Update nims.rst to reflect that -d:release is now allowed in config.nims (#18221)
`-d:release` and `-d:danger` started working in `config.nims` after df429fa287 .
2021-06-10 14:29:03 +02:00
Andrey Makarov
7e21218a07
follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
quantimnot
83ae70cb54
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
2021-03-18 20:37:55 -07:00
flywind
69a78c9183
promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08:00
KioriSun
f49d148a91
Fixing unexistant word in PT (#17070)
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.
2021-02-17 15:49:23 +01:00
Juan Carlos
15a45e8e73
Documentation update nims.rst (#14683)
* 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
2020-06-17 07:58:03 +02:00
hlaaftana
cd9af6b804
StringStream & more stdlib modules support for JS/NimScript (#14095)
* StringStream & more stdlib modules support for JS/NimScript

* change back pegs test in line with #14134
2020-04-28 19:44:52 +02:00
Juan Carlos
bb9b60604b [other] Documentation NimScript (#11548)
* Documentation of NimScript, update and expand, mention the benefits aside of its limitations, add examples, update the list of usable std lib modules
2019-06-23 20:08:21 +02:00
Araq
9348636cba docs: minor subjective improvement 2019-05-05 00:10:26 +02:00
Federico Ceratto
70f5d7fc42 Run nimscript without "nim e" (#11121)
Add a link to nimscript.rst
Add a suggestion on disabling hints.
2019-05-04 23:54:05 +02:00
Strømberg
2823da5e52 setCommand nop update documentation (#10254)
When I used Warning: Using `setCommand 'nop'` is not necessary.
2019-01-13 09:04:40 +01:00
Ico Doornekamp
a5fe676f37 Added 'Limitations' section to nimscript manual listing the restrictions of the VM (#10209) 2019-01-10 17:57:21 +01:00
Randy Smith
6c7abe6e5b Fixes #9671 (#9750) 2018-11-19 09:22:21 +01:00
Kaushal Modi
3e9f506923 Update config.nims search path in docs (#9388)
Related: https://github.com/nim-lang/Nim/pull/8682

Also mention the "nim help" command to list all available tasks.
2018-10-17 00:17:10 +02:00
Kaushal Modi
9709ac2bca Fix RST formatting; reword a notice about -d:release in .nims 2018-09-25 08:42:19 -04:00
Kaushal Modi
aecfacd39a Remove nim.cfg mentions from NimScript (nims) docs
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.
2018-09-24 14:11:54 -04:00
Adam Johnson
9ffed0de3f Documented shebang execution of Nimscripts 2017-05-21 22:19:13 +01:00
Araq
763c783bdf added distros.nim stdlib module for NimScript/Nimble support 2016-12-31 02:04:27 +01:00
Dominik Picheta
e6f6323e77 Fix inaccuracy surrounding Nimble in doc/nims.rst. 2016-11-21 20:55:37 +01:00
Araq
eed0128916 renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
Renamed from doc/nims.txt (Browse further)