-
Notifications
You must be signed in to change notification settings - Fork 129
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
@todo in unordered list breaks html #223
Comments
That's a bug. I hadn't considered @todo being used in anything other
than a normal paragraph, but that was an oversight. I don't much like
how I currently handle the HTML with @todo blocks so I'll try to figure
out how to make it a bit more robust.
…On 28/02/18 14:26, pvitt wrote:
When you add a ***@***.***| to a unordered list, the resulting html gets
corrupted.
Small working example:
|$ mkdir source $ cat << EOF > source/test.f90 > program TEST >
implicit none > write(*,*) 'Hello world!' > end program > EOF $ mkdir
test_pages $ cat << EOF > test_pages/index.md > title: Documentation >
> ## Usage > - Step 1 > - Step 2 > @todo this is a todo. > - Step 3 >
> An introduction to the usage of the features of whatever. > You are
guided through all required steps from generating stuff, > configuring
the solver and post-processing the results. > > An introduction to the
usage of the features of whatever. > You are guided through all
required steps from generating stuff, > configuring the solver and
post-processing the results. > > An introduction to the usage of the
features of whatever. > You are guided through all required steps from
generating stuff, > configuring the solver and post-processing the
results. > EOF $ cat << EOF > test.md > project: Test > src_dir:
source > output_dir: docu > page_dir: test_pages > title: Testpage >
md_extensions: markdown.extensions.toc > > Testpage > ======== > >
This is a testpage. > > [Here](page/index.html) is the Documentation.
> EOF $ ford test.md |
When you remove the ***@***.***| from |test_pages/index.md|, the file is
fine. The diff in the output looks like:
|$ diff -u broken.html fine.html --- broken.html 2018-02-28
15:08:51.000000000 +0100 +++ fine.html 2018-02-28 15:09:17.000000000
+0100 @@ -119,13 +119,12 @@ <h2 id="usage">Usage</h2> <ul> <li>Step
1</li> -<li>Step 2 -</p><div class="alert alert-success"
role="alert"><h4>Todo</h4><p>write page</li> +<li>Step 2</li> <li>Step
3</li> </ul> <p>An introduction to the usage of the features of
Musubi. You are guided through all required steps from generating
meshes, -configuring the solver and post-processing the
results.</p></div> +configuring the solver and post-processing the
results.</p> <p>An introduction to the usage of the features of
Musubi. You are guided through all required steps from generating
meshes, configuring the solver and post-processing the results.</p> |
Is this a bug? Or is it generally not allowed to use ***@***.***| in an
unordered list?
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<https://github.com/cmacmackin/ford/issues/223>, or mute the thread
<https://github.com/notifications/unsubscribe-auth/AHxJPXTfhYMPUSuYZ2c6bxUdKMA8L6DKks5tZWILgaJpZM4SWvM5>.
--
Chris MacMackin
cmacmackin.github.io <http://cmacmackin.github.io>
|
I think the cleanest approach is to base it on the existing admonition extension. This is probably a breaking change though, as I think it would involve dropping support for the
|
Replying to #357 (comment)
Great idea! Perhaps we could take it even further and convert it to the original markdown syntax (
From the Wiki:
I haven't tested it but I guess multiple paragraphs in a note are only possible if
Right now, I don't see why it wouldn't be possible, but you obviously gave it more thought that I did so far. |
See #410 for a first attempt. I kept the original FORD syntax, (not the one @ZedThree proposed). As far as I can tell everything works fine. (And #223 is fixed) I implemented an MD preprocessor that converts the FORD syntax for admonitions to the syntax of the built-in MD admonitions extension However, this was not sufficient because the built-in extension uses different CSS classes ( |
When you add a
@todo
to an unordered list, the resulting html gets corrupted.Small working example:
When you remove the
@todo
fromtest_pages/index.md
, the file is fine. The diff in the output looks like:Is this a bug? Or is it generally not allowed to use
@todo
in an unordered list?The text was updated successfully, but these errors were encountered: