Formatting of README files

Miklos Vajna vmiklos at collabora.co.uk
Tue Nov 25 00:44:36 PST 2014


Hi Chris,

On Tue, Nov 25, 2014 at 01:17:07PM +1100, Chris Sherlock <chris.sherlock79 at gmail.com> wrote:
> I noticed that there is some minor formatting capabilities on the
> docs.libreoffice.org website for readmes.
> 
> e.g. http://docs.libreoffice.org/vcl.html shows headings, which uses
> Wikimedia style double-equals signs before and after the heading text.
> 
> Are there any other formatting marks? If there are, are they documented
> anywhere?
> 
> Also, what would the feasibility of using Markdown syntax, ala github.io?

As I noted on IRC, solenv/bin/mkdocs.sh takes care of processing these
README files. If you want to tweak the syntax there, please submit a
patch against mkdocs.sh (and ideally the same patch adjusting the
existing README files if the syntax is not backwards-compatible).

Regards,

Miklos
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: Digital signature
URL: <http://lists.freedesktop.org/archives/libreoffice/attachments/20141125/53b08e8e/attachment.sig>


More information about the LibreOffice mailing list