Markdown syntax of README.md file present in a repository is not well rendered
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	rodolfojcj
	May 18 2014, 6:13 PM

Description

Consider the following block of markdown syntax:

<<<<< beginning of block >>>>

Requirements

Anything than Drupal and Drush require to work is required by this cookbook. Basically this means a Linux based environment as well as the following.

1. Packages to install
php-gd - required by Drupal
php-cli - needed by Drush
composer - needed by Drush
unzip - needed by Drush when downloading some zipped libraries or projects
git - needed by Drush when downloading some libraries or projects managed with Git
mysql - Drupal needs a database or a way to connect to a database
php5-mysql - Drupal needs a way to connect to a database
apache2 - the web server. Some work is needed to adapt

Platforms

This cookbook works on the following platforms:

Ubuntu 12.04

<<<<< end of block >>>>

Well, it seems to confuse the markdown parser of Diffusion because it shows incorrect indenting when exploring the web interface. I opened the same file with ReText editor and its previewing is fine.

Also I modified the markdown syntax a little to help Phabricator, as this:

<<<<< beginning of block >>>>

Requirements

Anything than Drupal and Drush require to work is required by this cookbook. Basically this means a Linux based environment as well as the following.

Packages to install

The following packages are installed by this cookbook:

php-gd - required by Drupal
php-cli - needed by Drush
composer - needed by Drush
unzip - needed by Drush when downloading some zipped libraries or projects
git - needed by Drush when downloading some libraries or projects managed with Git
mysql - Drupal needs a database or a way to connect to a database
php5-mysql - Drupal needs a way to connect to a database
apache2 - the web server. Some work is needed to adapt

Platforms

This cookbook works on the following platforms:

Ubuntu 12.04

<<<<< end of block >>>>

It is better but it renders some headers wrong, showing them as a kind of ordered list with all items being number 1.

Note: As I edit this posting, I am seeing the "Description Preview" bellow is showing the same kind of messing I am reporting.

No big deal, but it will be fine if corrected.

Thanks!

Revisions and Commits

rPHU libphutil
	D10151	rPHU25c1599e34e0 Make `#` header detection more strict
	D10045	rPHUfceef0248d67 Interpret "## text"-style Markdown headers
	D10044	rPHU371c33b73585 Improve text mode rendering of reverse Remarkup list staircases
	D10043	rPHU2603d59f43b0 Fix crazystairs with non-stairlike reverse-indented lists
rP Phabricator
	D10046	rPda49ae8fe2f3 Bump remarkup engine version for new list stuff

Related Objects

Mentioned Here: T5698: Github-style Remarkup previews on a checked-in resource

Event Timeline

rodolfojcj created this task.May 18 2014, 6:13 PM

rodolfojcj raised the priority of this task from to Normal.

rodolfojcj updated the task description. (Show Details)

rodolfojcj added a project: Diffusion.

rodolfojcj added a subscriber: rodolfojcj.

We currently interpret # to mean "ordered list", and allow you indent lists by adding an arbitrary number of list markers, so "##" is interpreted as "second level ordered list".

We can special case this case specifically, but couldn't unambiguously differentiate this right now:

# intended header
- intended list

See also T2849.

(And that first staircase seems buggy, although hilarious.)

Ok, fine!

I thought Phabricator used the same syntax that Github. Now it is clear with your answer that it is related to Remarkup vs. Markdown.

Thanks!

We try to be reasonably compatible with normal Markdown. We can improve these cases.

With D5854 covering the H1 and H2 headers for markup, it'd be nice if Remarkup could parse Markdown headers below H2, which should reduce conflicts with lists at least.

Raw input text for crazy stairs is:

Requirements
-------------------
Anything than Drupal and Drush require to work is required by this cookbook. Basically this means a Linux based environment as well as the following.

## Packages to install
- `php-gd` - required by Drupal
- `php-cli` - needed by Drush
- `composer` - needed by Drush
- `unzip` - needed by Drush when downloading some zipped libraries or projects
- `git` - needed by Drush when downloading some libraries or projects managed with Git
- `mysql` - Drupal needs a database or a way to connect to a database
- `php5-mysql` - Drupal needs a way to connect to a database
- `apache2` - the web server. Some work is needed to adapt

## Platforms
This cookbook works on the following platforms:
- Ubuntu 12.04

epriestley added a revision: D10043: Fix crazystairs with non-stairlike reverse-indented lists.Jul 24 2014, 11:17 PM

epriestley added a revision: D10044: Improve text mode rendering of reverse Remarkup list staircases.Jul 24 2014, 11:20 PM

epriestley added a revision: D10045: Interpret "## text"-style Markdown headers.Jul 24 2014, 11:34 PM

epriestley added a revision: D10046: Bump remarkup engine version for new list stuff.Jul 24 2014, 11:40 PM

epriestley claimed this task.Jul 24 2014, 11:40 PM