Hi, are there any development plans, or any tip/suggestion, to integrate ReStructuredText documentation format and PlantUML diagrams into fossil?

https://en.wikipedia.org/wiki/ReStructuredText

https://en.wikipedia.org/wiki/PlantUML

Thanks in advance!

I dove into ReST for a while, intending to write a Lemon parser for it for addition to Fossil but then ran aground on the fact that you need to provide Lemon with a lexer. The question then becomes, how do you lex ReST? What are the lexical elements of a nearly free-form ASCII text document format?

Since I could only come up with wild guesses, and I didn't want to just try them all until one worked, I set the project aside.

(The wild guesses for those who want to try and proceed: a) just send the parser each byte in turn and let it figure things out; or b) break on every special character in ReST, then goto a).)

Hope it helps,

That (markdeep) is amazing. This is the first i have heard of it. Thank you for sharing.

even include the JS minified file in your repo, as a unversioned file

Just FYI: you can easily serve the JS file and any CSS files directly from versioned content without any trickery. Search this fossil embedded doc page for baseurl/doc and baseurl/raw for several examples. That way anyone who clones your repo has all of the necessary pieces (in their current versions) automatically, without having to pull the unversioned files.

Thanks a lot Stephan.

I was thinking about unversioned files because a third party minified JS was kind of a binary that would not change that much, so I was thinking in some kind of script or command to pull the unversioned files. But the case you made with HighlightJS is good enough to look for something similar.

We will try something in that front soon and share here back.

Cheers,

We have done that for several repos, like this ones: ... Hope it helps,

Markdeep is really interesting, providing more power than markdown while retaining (for the most part) its ease of use. i spent the past 2 hours or so experimentally porting an MD doc to it, and most of that time was spent bending the CSS to my will:

https://fossil.wanderinghorse.net/r/morbad-card-tools-s2cgi/doc/ckout/doc/index.html (edited for renamed link)

Resize the browser to see the table of contents move back and forth from the top of the doc to the sidebar. That's a killer feature. It could be done via CSS in plain markdown, but the ToC itself would have to be hand-generated, whereas markdeep does that automatically.

The only marginally annoying bit, when integrating it into a fossil repo, was getting the fossil page links working. e.g. a link like /finfo/foo.c only works if the repo lives at the top of its domain, which none of mine do. That has to be worked around by using relative links like ../../../finfo/foo.c. Not a big deal, only slightly ugly.

Thank you again, Offray!

You're welcomed Stephan... This kind of reciprocity maybe is just a way to say thanks again for the JSON API. :-)

Cheers,

Offray

Markdeep looks very interesting, though all the documentation seems to be examples. Also, I wasn't able to find an actual specification for Markdeep.

Still, thanks.

The spec is essentially the demo page, which, according to that page, acts as the demonstration of all features and as a test of its features.

It's essentially markdown plus a huge pile of extensions.