summary refs log tree commit diff stats
path: root/doc/tools.rst
Commit message (Collapse)AuthorAgeFilesLines
* Improve Markdown code blocks & start moving docs to Markdown style (#19954)Andrey Makarov2022-07-151-42/+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
* follow-up #18013 - inline syntax highlighting (#18166)Andrey Makarov2021-06-041-7/+8
|
* RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) ↵quantimnot2021-03-181-5/+7
| | | | | (#17258) Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* Massive documentation fixes + copy editing (#15747)Yanis Zafirópulos2020-10-291-2/+2
|
* added testament documentation link to tools.rst (#15481)David Krause2020-10-051-1/+1
|
* [backport] Documentation Fix #12251 (#13226) [ci skip]Juan Carlos2020-01-221-0/+8
|
* Prefer relative links for Nim documentationJjp1372019-10-221-1/+1
| | | | | | | | | | | This is more friendly to those browsing the documentation without a network connection. The nim-doc package in Debian allows this, for example. Also, the domain name being used was not consistent. It could have been either nim-lang.org or nim-lang.github.io, and those reading the stable docs could have found themselves suddenly reading the devel docs instead.
* add HCR document to the tools.rst listAraq2019-06-181-0/+4
|
* [bugfix] Fixes #11434 , Update Tools Documentation (#11449)Juan Carlos2019-06-171-0/+7
|
* fix `c2nim` linknarimiran2019-06-041-1/+1
|
* more documentation improvements; fixes #9119Araq2018-09-291-1/+1
|
* integrate 'koch web' features into koch; deprecate 'nimweb' toolAraq2018-09-131-0/+20