Comments (3)
Hi Mario, glad you're finding it useful :)
Is the question about how support can be added directly within this tool for producing asciidoctor documentation as an output? If so, it's definitely a possibility. The output format is managed by two things:
-
The Format that you use. This is where the details of the markup language used are really expressed. I'm not familiar with asciidoctor's syntax, but I'm guessing it's probably different enough from the three markdown formats implemented (see the structs documented here) to warrant a separate format implementation. This is selected via the
--format
option, but is not customizable outside of choosing which implementation you want to use. -
The templates that structure those components into the overall documentation. The templates are user-configurable, but the default implementations can be found here. They're designed to be generic enough that they should work for most markup formats with an appropriate formatter implementation, but I'm open to the idea of different templates being used depending on format type if needs dictate.
If your goal is direct support for asciidoctor, the best bet is probably to add a new formatter to the package. I will happily accept Pull Requests for adding asciidoctor support if you're interested in trying to add it.
from gomarkdoc.
@princjef Thanks a lot for your good explanations & the nice library! :) I'm currently trying to create a formatter. ASCIIDOC is quite much more complex but I strive to keep it simple stupid. However, I probably need to not escape lots of texts since I need to be able to create tables, sequence diagrams, flowcharts etc. via asciidoctor and mermaid et.al. We're using kroki to generate such diagrams (we're using a local docker - but it is quite possible to use the online version - takes a few more seconds to do so :)).
I've forked and committing into my fork. When I've got something that may work - I'll ping you and if you have the time to have a look before creating the PR to polish it up :)
Cheers,
Mario :)
from gomarkdoc.
Hi @princjef - thanks for all the support you've given me. I've done a shot at a formatter but I realized that markdown and asciidoc is too different beasts and hence I've started a separate project that generates asciidoc from go code.
Again, thanks for you support!
Cheers,
Mario
from gomarkdoc.
Related Issues (20)
- Pre-commit support HOT 1
- String manipulation functions in template
- Potential incorrect Markdown link syntax HOT 4
- [Bug] Check mode always returns with zero exit code when embed mode is also enabled HOT 1
- Is there a way to omit certain functions? HOT 2
- Pandoc Markdown Support
- Generated files have an execution permissions on Linux
- Multiple newlines are generated during templates processing
- Bug in generating markdown files with characters *(){}[]- HOT 1
- Ability to choose codeblock language HOT 2
- Generate wrong index for go 1.18 generic code HOT 6
- support new godoc spec enforced by gofmt HOT 3
- Links in comments aren't generated correctly HOT 1
- git branch issue when running in ci environment HOT 2
- new headings syntax in go 1.19 HOT 1
- Is there a way to generate docs for all packages in a project HOT 1
- Ignoring appending into generated docs when using -e flag HOT 2
- add support for Template functions HOT 3
- Ignore vendor folder HOT 4
- Links appear broken in README files HOT 2
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 gomarkdoc.