yoavram / markx

Markdown editor for scientific writing. Batteries included.
Other
319 stars 41 forks source link

Nested list syntax and typo fixes in Help.md #58

Closed neitsab closed 9 years ago

neitsab commented 9 years ago

Small typo corrections, and make nested list indentation in Toolbar section conform with pandoc's markown so that the export produces valid HTML (and other formats).

Current exported HTML:

<h3 id="toolbar">Toolbar</h3>
<ol style="list-style-type: decimal">
<li>Use the <em>GitHub</em> <i class="icon-github-2"></i> button to <strong>sign-in to <a href="https://github.com/">GitHub</a></strong> (see more details below).</li>
<li>Use the <em>Screen</em> <i class="icon-screen"></i> button to change between <strong>editor</strong>, <strong>preview</strong> and <strong>dual</strong> modes.</li>
<li>Use the <em>Books</em> <i class="icon-books"></i> menu to <strong>parse citation keys</strong> such as [@Drake1991], to load a bibliography file, to see the loaded bibliography and the references you are citing.</li>
<li>Use the <em>Download</em> <i class="icon-download-2"></i> menu to <strong>download and convert</strong> the Markdown text to various formats or to download a <a href="http://daringfireball.net/projects/markdown/">Markdown</a> of the text or a <a href="http://www.bibtex.org/">BibTeX</a> file of the citations referenced in the text.</li>
<li>Click on <strong>P</strong> or <strong>D</strong> to <strong>change the Markdown converter</strong> between <a href="http://johnmacfarlane.net/pandoc">Pandoc</a> and <a href="http://www.docverter.com/">Docverter</a>.</li>
</ol>
<ul>
<li>Pandoc: must be installed on local machine when working locally, can't process image URLs, slow conversion to PDF on Windows, requires <em>pdflatex</em> to convert to PDF on local machine.</li>
<li>Docverter: must be connected to the internet to be used, doesn't process citation keys and bibliography.</li>
</ul>
<ol style="list-style-type: decimal">
<li>Click the <em>Code</em> <i class="icon-code"></i> button to get change the <strong>code highlighting styles</strong>. Example code above.</li>
<li>The grey boxes with the numbers display the <strong>word and character counts</strong>.</li>
</ol>

(shows as a new, not nested bullet list)

After indentation fix:

<h3 id="toolbar">Toolbar</h3>
<ol style="list-style-type: decimal">
<li>Use the <em>GitHub</em> <i class="icon-github-2"></i> button to <strong>sign-in to <a href="https://github.com/">GitHub</a></strong> (see more details below).</li>
<li>Use the <em>Screen</em> <i class="icon-screen"></i> button to change between <strong>editor</strong>, <strong>preview</strong> and <strong>dual</strong> modes.</li>
<li>Use the <em>Books</em> <i class="icon-books"></i> menu to <strong>parse citation keys</strong> such as [@Drake1991], to load a bibliography file, to see the loaded bibliography and the references you are citing.</li>
<li>Use the <em>Download</em> <i class="icon-download-2"></i> menu to <strong>download and convert</strong> the Markdown text to various formats or to download a <a href="http://daringfireball.net/projects/markdown/">Markdown</a> of the text or a <a href="http://www.bibtex.org/">BibTeX</a> file of the citations referenced in the text.</li>
<li>Click on <strong>P</strong> or <strong>D</strong> to <strong>change the Markdown converter</strong> between <a href="http://johnmacfarlane.net/pandoc">Pandoc</a> and <a href="http://www.docverter.com/">Docverter</a>.
<ul>
<li>Pandoc: must be installed on local machine when working locally, can't process image URLs, slow conversion to PDF on Windows, requires <em>pdflatex</em> to convert to PDF on local machine.</li>
<li>Docverter: must be connected to the internet to be used, doesn't process citation keys and bibliography.</li>
</ul></li>
<li>Click the <em>Code</em> <i class="icon-code"></i> button to get change the <strong>code highlighting styles</strong>. Example code above.</li>
<li>The grey boxes with the numbers display the <strong>word and character counts</strong>.</li>
</ol>

Thanks a lot for Markx, it is a great, useful tool!

yoavram commented 9 years ago

I'm glad to hear, thanks!!