But I am not so sure about the diagramming feature. Writing diagrams as ascii art seems like a PITA to me, especially when you need to update a diagram with new shapes, etc.
For this I prefer PlantUML markdown integration: http://plantuml.com
I use VS Code and it has a nice plugin to handle this.
(Also, this: https://github.com/plantuml/plantuml/pull/94)
Something to keep in mind.
I have been working on a tool like markdeep but with PlantUML-like syntax. It's here: http://markdown.online
The syntax help page is a kitchen-sink of what's supported: http://markdown.online/view/public/syntaxhelp
Planning on supporting more than sequence and flowcharts, but for now that's what I have.
Please note, this is not ready yet for prime time, it's alpha quality at best.
Finally, I think there is a place for a tool like Markdeep. There is only so much expressiveness that a tool like mine can support. Yes, ascii art to diagrams is PITA, but it is the most generic solution if you want diagrams with flexibility. I find my tool and tools like PlantUML to fit in the other end of the spectrum, you want a quick diagram without much fussing over how it really looks.
Are you doing the rendering completely client side?
>you want a quick diagram without much fussing over how it really looks.
It's also way easier to edit and collaborate with. Could even be version controlled in a source-code way.
> It's also way easier to edit and collaborate with. Could even be version controlled in a source-code way.
Overall idea is to make this into a wiki. I am also planning to add an ability to collaboratively edit the same page (like google docs).
In terms of version control, yes, also thought about it. It's a bit more complex, and I don't have a good architecture as a solution at the moment.
* As long as you have good coordination.
:Actor: --> (UseCase)
<!DOCTYPE p [
<!ELEMENT p - - ANY>
<!ELEMENT em - - (#PCDATA)>
<!ENTITY start-em '<em>'>
<!ENTITY end-em '</em>'>
<!SHORTREF in-p '*' start-em>
<!SHORTREF in-em '*' end-em>
<!USEMAP in-p p>
<!USEMAP in-em em>
<p>The following text:
will be put into EM
Is this one of those pieces of occult witchery that SGML excels at..?
You are quite right. I should probably have said something more like "XML was intended by its creators more for machine than human consumption" (and, incidentally, creation; I think I have read that XML construction wasn't really intended to be done by humans either).
Say I have a table with a 'name' and 'value' column and 100 entries. And I'd like names to be alphabetically sorted. So far so good.
But this table is too long and too small, so I want to have 4 columns and 50 rows, where the name/value continue in column 3, 4. Out of luck. This is unmanageable, as you have to shift many cells when adding a new entry.
A proposal for something like this: https://github.com/github/markup/issues/1189
Also mentions multi-line cell contents, which are hard in regular markdown (require inline html)..
It can be abstracted into a function though, here's a different table done from only markdown (and backed by a database!)
org-mode's tables can do a lot of things.
Jeff Atwood tried to fix this, but the creator of Markdown does not seem keen to cooperate with any attempts to standardize it.
Since he owns the trademark, standardization will likely be impossible without his cooperation. Not to come down on John Gruber, I understand his position and he’s a cool cat... it’s just an unfortunate shortcoming of markdown, which I otherwise love.
With the exception of ordered lists. I can never figure out how to get multiple paragraphs or interstitial content into ordered lists, and it always resets the counter to 1... but everything else is great!
Here is a very short intro on rendering in your browser:
Asciidoc.org at some time in the future should be the page for the language spec. The biggest feature is probably that you can produce DocBook and it's very easy!
"Any sufficiently complicated typesetting system contains an ad hoc, informally specified, bug-ridden, slow implementation of half of LATEX."
Markdeep is no exception.
N.B. the online publishing platform Leanpub has its own mark* variant, "markua" which actually does recognize a poem section -- although as implemented it has minor formatting issues.
It also shows with built in version control, you don't have to know git to use it
There are multiple other features, like WYSIWYG diff and version control that make this app compelling
Markdeep might be a good idea, but if you start adding more and more feature you reimplement HTML, at that point why not simply use HTML? Isn't HTML plain text, too?