swagger2markup / markup-document-builder Goto Github PK
View Code? Open in Web Editor NEWA Markup document builder which supports AsciiDoc, Markdown and Confluence Wiki.
License: Apache License 2.0
A Markup document builder which supports AsciiDoc, Markdown and Confluence Wiki.
License: Apache License 2.0
Missing table align for markdown. Any plan?
Hi Robert,
In addition to the definitions.adoc
that gets generated, I would like to generate individual files for each object (ex: person.adoc
, address.adoc
, purchase.adoc
...). I'd like to reference the model from a separate document that I've written, but I would like to include the object definitions individually in specific sections rather than in a single section. Do you think this would be something useful? I haven't dived into the code yet, but I'd be willing to take a stab at it. Do you think it would be something horribly difficult as the design stands, and would it be something possibly useful to others?
Thanks!
Sebastien
Hi,
Due to factory using a concrete enum as input it is not possible to add builders for additional markup-languages without modifiying your code. I'd like to use your tool to generate output for Confluence/Jira and it would be really cool to have a simple plugin mechanism.
I've sketched a possible solution (which should not break your existing interface) in 7e0d5bc, what do you think?
Regards
André
Context :
Solution :
- current <- trim()
- input <- current
- current <- Normalizer.normalize(Normalizer.Form.NFD)
- current <- replaceAll("\\p{Punct}+", "")
- current <- lowercase()
- current <- replaceAll("\\s+", ADOC("_") | MD("-") )
- base <- current
- current <- replaceAll("[^a-z0-9-_]+", "")
if (current.size() != base.size())
- current <- hash(input) // use input to maximize uniqueness
end
if (ADOC)
- current <- prefix with "_"
- current <- suffix with "_" if endsWith("-")
end
When a section has an explicit custom anchor, AsciiDoctor reuse it as-is for HTML id generation.
Sections :
Manual anchors :
Sections :
Manual anchors :
HTML 4
ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters (UTF-8), digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
HTML 5 :
The value must be unique amongst all the IDs in the element's home subtree and must contain at least one character. The value must not contain any space characters.
There are no other restrictions on what form an ID can take; in particular, IDs can consist of just digits, start with a digit, start with an underscore, consist of just punctuation, etc.
An element's unique identifier can be used for a variety of purposes, most notably as a way to link to specific parts of a document using fragment identifiers, as a way to target an element when scripting, and as a way to style a specific element from CSS.
Please add support for something matching the AsciiDoc :toc: tag.
Hi I am trying to create a pdf document for my API's using 'swagger2markup-maven-plugin' and 'asciidoctor-maven-plugin'. I am getting following error "Failed to execute goal 'convertSwagger2markup': text must not be blank" . It fails when trying to validate boldTextLine text. Here is how my api documentation looks like
@ApiOperation(value = “Fetch User details.”,
notes = "Return user details as a key-value pair.",
response = User.class,
httpMethod = "GET"
)
@RequestMapping(value=“/users/{id}”, method = RequestMethod.GET, produces = {MediaType.APPLICATION_JSON_UTF8_VALUE})
public User<String, Object> fetchDetails(@PathVariable final String id,
final HttpServletRequest request, final HttpServletResponse response){
return new User<>();
}
The readme contains:
<dependency>
<groupId>io.github.robwin</groupId>
<artifactId>markup-document-builder</artifactId>
<version>1.0.0</version>
</dependency>
this version does not exist in maven central. Perhaps it is useful to update the readme to:
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>markup-document-builder</artifactId>
<version>1.1.1</version>
</dependency>
Too bad the nl.jworks.markdown_to_asciidoc dependency is not in maven central.
Swagger2Markup/swagger2markup-maven-plugin#25
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.