search

asciidoctor / atom-asciidoc-preview

⚛ AsciiDoc preview for the Atom editor.
https://atom.io/packages/asciidoc-preview
MIT License
141 stars 42 forks source link

Update the readme with the :toc: left thingy #284

Closed refaelsh closed 6 years ago

refaelsh commented 6 years ago

Following the discussion here, I am proposing this change in the README.

mojavelinux commented 6 years ago

Thanks for getting this started.

I already updated the options section to add a note about how toc works in the preview. So I think that's now covered.

What I'd like to request is to change this "Note" section to "Disclaimer" and just keep the second sentence. That way, we make it clear that the preview is not meant to look exactly like a standalone HTML document but rather to provide a reasonable preview for the content portion. We can then refine this statement as we get feedback.

It might be good to mention that the preview tries to make the best use of the limited space, so it only shows the main content.

refaelsh commented 6 years ago

Thanks for getting this started.

You are welcome :-)

I already updated the options section to add a note about how toc works in the preview. So I think that's now covered.

I just now noticed it. Sorry. I should not have created the Pull Request.

What I'd like to request is to change this "Note" section to "Disclaimer" and just keep the second sentence. That way, we make it clear that the preview is not meant to look exactly like a standalone HTML document but rather to provide a reasonable preview for the content portion.

Done. Pushed a new commit.

It might be good to mention that the preview tries to make the best use of the limited space, so it only shows the main content.

Done.

mojavelinux commented 6 years ago

I made some revisions.

@ldez I think this is good to go. Let me know if there are any revisions you'd like to propose. I think this disclaimer should curtail issues about the preview looking different than the default stylesheet.

mojavelinux commented 6 years ago

Thanks for reviewing.

Would you like to take care of merging?