-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Change log | ||
title: Change Log | ||
--- | ||
|
||
*Current release* | ||
|
4 comments
on commit 866921c
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry guys, it seems that it's quite hard to write markdown which will give the same result in two different markdown parsers :(
I was "fixing" this to make output look correctly in web version (http://esp8266.github.io/Arduino/versions/2.0.0-rc2/), apparently need to make a few iterations to find the right amount of spacing so both versions look the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Frankly saying I was not aware that three is a separate version of documentation attached to each release until I checked this commit.
Did you consider using only one type of documentation for s/w releases and for github repository?
I am not sure what it takes to maintain two versions but I believe they will never be the same π
I would appeal that instead of bothering how to fix it, drop one of them and allocate your time to strategic development of this cool s/w π
Web version looks nicer to me than md. Is it possible to drop all md files except readme.md and provide a link under https://github.com/esp8266/Arduino/wiki to the latest html documentation?
Krzysztof
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed tables of contents and images, please let me know if i missed anything.
Turns out, GFM needs an empty line before an image, while kmarkdown doesn't. Just something to remember when writing future docs.
looks like this change make problems with the github md view.