Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#9587 closed Task (invalid)

Convert .md files to .html or even .txt

Reported by: Alfonso Martínez de Lizarrondo Owned by:
Priority: Normal Milestone: CKEditor 4.0
Component: Project : CKBuilder Version: 4.0
Keywords: Cc:

Description

In order to make it easier for people that aren't used to github to read the documentation, the builder should convert the .md files to .html or at least rename them to .txt so it's clear that they can be opened with a text editor even if the formatting might be a little strange.

Change History (4)

comment:1 Changed 7 years ago by Piotrek Koszuliński

Milestone: CKEditor 4.0

Not sure if we'll have enough time, but 4.0 for now.

comment:2 Changed 7 years ago by Jakub Ś

Status: newconfirmed

comment:3 Changed 7 years ago by Piotrek Koszuliński

Resolution: invalid
Status: confirmedclosed

After a discussion we decided that we'll keep MDs file. It's a common standard nowadays and it should not be a (big) problem for people to open these files. What's more, Markdown is really readable in its source mode, so even in normal text editor it can be read without problems.

However, if we'll notice that people are facing some difficulties, then we'll change something :).

comment:4 Changed 7 years ago by Frederico Caldeira Knabben

Btw, alfonsoml said "documentation", which makes me think that he's talking about the stuff inside /dev/docs. If that's the case, than it is something to not be aware of really as we'll definitely have HTML on release. Just the "source" is .md.

If it's just about the root .md files instead, then Piotrek already clarified it.

Note: See TracTickets for help on using tickets.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy