As was made clear in the [community survey 
results](http://forum.nim-lang.org///forum.nim-lang.org/t/2512), many see the 
Nim documentation as being an area for improvement.

I recently started a project to work on this exact area, by creating a version 
of the Nim guide/tutorial as a [GitBook](https://github.com/GitbookIO/gitbook). 
There are several reasons this is advantageous in my eyes:

  * Documentation is written in markdown, a syntax many are familiar with.
  * The online version of the documentation has tools to change the font size 
and font style, as well as changing the background between dark style 
background and light style background (different styles are better for 
day/night time)
  * The online version is searchable
  * The documentation can be created as HTML for browsing online
  * It can also be used to create a PDF or an EPUB ebook automatically (for 
offline usage, which is extremely handy!)



I've only just started this project so far, but have a couple of early sections 
available. There's a live version available here: 
[http://nim-docs.euant.webfactional.com/index.html](http://forum.nim-lang.org///nim-docs.euant.webfactional.com/index.html),
 and the code is all available on GitHub, here: 
[https://github.com/euantorano/nim-docs](https://github.com/euantorano/nim-docs).

I'd be interested to know what people think such a guide should cover, and in 
what kind of order. Ideally I'd like it to be able to serve as a complete 
introduction and I plan to cover both beginner topics (what is a variable, what 
is a procedure/function, etc.) and advanced features that make Nim what it is 
(templates, macros, etc.).

I'd welcome any kind of feedback or contribution on this - would anybody 
actually se such a version of the guide/documentation? If you were/are just 
starting to learn Nim, would this kind of guide be useful? I'm aware I might be 
stepping on @dom96's toes slightly here given his existing book, and I don't 
intend to draw any focus away from that ;)

Reply via email to