Comments (8)
Benjamin, you or we should check the pandoc conversion - as the Markdown version of the template is generated from the original AsciiDoc source
So instead of cleaning the markdown manually, I suggest we find a better/cleaner way of generating or transforming adoc->markdown...
cc @rdmueller
from arc42-template.
@gernotstarke definitely generating from source is the way of choice! I've not looked into pandoc yet - so if one of you guys has the chance to look into it that would be great. ;-)
from arc42-template.
yes, we should try to configure pandoc or look for another converter and not try to clean it manually.
the main problem I see is that there are so many markdown dialects. So which should we use?
For instance, the original markdown is not capable of generating tables: https://daringfireball.net/projects/markdown/syntax
For those who want to play around with the settings - the code we use to generate markdown can be found here: https://github.com/arc42/arc42-generator/blob/master/subBuild.gradle#L185
We already generate "markdown", "strict markdown" and "github markdown"
from arc42-template.
@benjaminburkhardt - neither @rdmueller nor myself have a chance to look into this issue in the near future, therefore I ask for your help.
I leave this issue open, maybe other folks have time and/or ideas...
from arc42-template.
I think "strict markdown" already solves all of the problems mentioned above. But it does not seem to be available for download on arc42.org/download but only from this repository.
from arc42-template.
markdown is available... https://github.com/arc42/arc42-template/raw/master/dist/arc42-template-EN-plain-markdown.zip
do you suggest to add "markdown-strict" as additional download on arc42.org?
from arc42-template.
I wasn't aware that there were more download options than published on arc42.org.
It was only by chance after finding this issue that I found the markdown-strict template. Maybe it would be helpful for others if it was directly available on the website. So my answer to your question would be "yes".
from arc42-template.
added several additional download formats...
from arc42-template.
Related Issues (20)
- Cross-cutting concepts vs cross-cutting concerns HOT 4
- explicitly mention the source revision and language for translations HOT 1
- Ascii-doc/Markdown has 'Introduction' as title, and all sections as subsections HOT 5
- template (DE and EN) contain outdated ISO-25010 overview HOT 3
- DE: Kontext, bad text in description HOT 1
- heading numbers missing in docx version
- Sect 5, Building Block explanation, overly long bullet list (DE+EN) HOT 2
- check order of image-usage and config-include HOT 1
- replace proprietary graphics format with drawio
- broken build HOT 2
- bump up version id to 8.1.1 to reflect latest EN fix HOT 1
- Suspicious HTML code block in documented Markdown file (EN)
- download issues with template/arc42.org HOT 2
- Resolution of images doesn't work well in asciidoc editors HOT 4
- arc42 template (and some websites) are not accessible for visually impaired people
- Make generated language configurable by property
- Check generated html with sanity checker HOT 1
- Superfluous file ES/asciidoc/src/appendix-open_issues.adoc?
- Wrong Headline for Chapter 3 - Context and Scope HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from arc42-template.