New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown: code not rendered correctly #39

Open
cweiske opened this Issue Feb 15, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@cweiske

cweiske commented Feb 15, 2017

The example code on https://docs.typo3.org/typo3cms/extensions/flux/ is not rendered correctly.

It renders nicely on github: https://github.com/FluidTYPO3/flux/blob/development/README.md

2017-02-15 docs typo3 org fluid

@cweiske

This comment has been minimized.

Show comment
Hide comment
@cweiske

cweiske Mar 14, 2017

The flux README uses the following markup to specify the language:

```xml
<flux:form id="myform">
  <flux:field.input name="myField" label="My special field" />
</flux:form>
```

cweiske commented Mar 14, 2017

The flux README uses the following markup to specify the language:

```xml
<flux:form id="myform">
  <flux:field.input name="myField" label="My special field" />
</flux:form>
```
@sypets

This comment has been minimized.

Show comment
Hide comment
@sypets

sypets Jul 30, 2018

In this case, I would suggest to convert the markdown Readme to reST. Restructured text code blocks will render nicely on Github and on the documentation server docs.typo3.org. Most of the TYPO3 documentation is written in reST.

See also: https://docs.typo3.org/typo3cms/HowToDocument/Appendix/SupportedFilenamesAndFormats.html

and

https://docs.typo3.org/typo3cms/HowToDocument/WritingReST/Codeblocks.html

You can use the tool pandoc to convert.

sypets commented Jul 30, 2018

In this case, I would suggest to convert the markdown Readme to reST. Restructured text code blocks will render nicely on Github and on the documentation server docs.typo3.org. Most of the TYPO3 documentation is written in reST.

See also: https://docs.typo3.org/typo3cms/HowToDocument/Appendix/SupportedFilenamesAndFormats.html

and

https://docs.typo3.org/typo3cms/HowToDocument/WritingReST/Codeblocks.html

You can use the tool pandoc to convert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment