maccoda / made-up Goto Github PK

At the moment the configuration only allows a single styelsheet but they are called cascading style sheets so really should allow for multiple.

The HTML generated incorrectly generates nested lists, it does not append the closing li tag in the correct place as shown:

<li>Point two
    <ul>
        <li>Indent point one</li>
    </ul>
</li>

Currently it does not differentiate between ordered and unordered lists. All lists are rendered as unordered.

The title of the rendered pages are all the same. That is pretty boring!
Make the title append the name of the file perhaps to make it more useful.

The ordering of the table of contents in the generated index file is inconsistent, particularly across OS. This is causing the tests to fail as per PR #2. Need to either make the tests more robust as this is not really a failing issue or add in functionality to ensure that the files are always obtained in the same order.

If the configuration has gen_index set to true it will generate the index correctly but no check is done to ensure it won't be overwritten by generated content. That is, no check is done to see if an index.md exists. It should fail if this is the case as the user has likely incorrectly configured the tool.

Current the elements provided to the handlebars index template are the file names. This makes for an unattriactive index page. Instead these should be returning the main heading for that page which is guaranteed to be more human readable.

When trying to move to the Trust CI template it was made apparent the flaw in the design in that the library would perform the writing to the file, this meant that the integration test would be writing within the source code. Instead this should be changed so that during the integration testing it can create a temporary directory to write the output to.

When doing this will also mean that the ci feature can be removed as all testing should be able to be done.

This tag type is unhandled and is causing issues with the output produced moreso when not actually using HTML tags but referencing names. Essentially this should just be printing directly to the output as the inline HTML should be unchanged and when it isn't actually HTML then it needs to be ensured that it is printed correctly.

Particularly for the index page but in general need to have a way to reflect the directory structure in the page hierarchy. One idea is to recursively generate index pages for each sub-directory, another is to look into a better template that has a navigation panel with a section for each directory.