Comments (6)
+1
from asciidoctor.org.
Apart from new features, I think it could be interesting to document issue asciidoctor/asciidoctor#116 because I think it is really interesting feature. I will try to update AsciiDoc Syntax Quick Reference document with all these features when I had some time.
from asciidoctor.org.
I had to look up what a docinfo file was. If I understand it correctly, it is a file that can contain document header attributes, JavaScript scripts, and CSS styles (when applied to the html5 backend)?
I'm also assuming that it is defined when :docinfo:
is added to the document's header?
- How does it know where to find the
docinfo
file? - What is the structure and applicable syntax in the
docinfo
file? - Is anyone using one that we could use as an example?
- Are there different rules and constraints when using the DocBook backend?
Next, this issue (Update new features into AsciiDoc Syntax Reference) is indicative of a larger documentation conundrum 💔
Asciidoctor now has so many features (new, compliance, integrations, backends, and implementations) that the Quick Reference Guide is no longer a quick read because it is growing into a guide to all the Asciidoctor features. And it is growing into the complete reference guide because we haven't created a complete reference guide 🙀
For now, I have updated the Quick Reference Guide with most of the new syntax and features from 0.1.3 (I'll commit it by the end of the day today MDT).
However, this is just a stop gap. A complete reference guide of all the Asciidoctor features is needed and is in the works. First though, we need to decouple the docs from the website (See asciidoctor/asciidoctor#541).
from asciidoctor.org.
Hi,
well you can see an example in Dan's deck repository https://github.com/mojavelinux/decks/tree/master/discover-zen-writing-asciidoc which is used for setting some css attributes in slides.
Also you can watch this issue (asciidoctor/asciidoctor#116) which is the original implementation of docinfo
support and contains the documentation of AsciiDoc original guide explaining the attributes. As you will read on that document you will see that there are three possible attributes docinfo
, docinfo2
and docinfo3
. The first one includes a document with next file format Include -docinfo., the second one docinfo. and the third one both formats. Also keep in mind that in case of html output a extension of that file is html, and in case of docbook it is an xml extension.
Also it is important to note that you can still resolve attribute values into that files, here you can see an example, basically you can get attribute values defined in adoc
files.
asciidoctor/asciidoctor#403
And finally if you inspect issue asciidoctor/asciidoctor#486, for 0.1.4 version this files would be possible to be included in footer instead of header.
About documentation I agree with you that quick reference is becoming to a full documentation. In my opinion, I think that this documentation should add next big chapters:
- how to install / render a document
- reference
- customizing (templates, stylesheets, ..)
- Working with Ruby (which includes how to write filters, extensions, extensions, ...)
- Toolchain (Java, Maven, Gradle, Asciidoctor.js, ...)
Also when all documentation will be written, I will translate it to Spanish, so I think we must think about an structure which allows us writing in different languages.
from asciidoctor.org.
@lordofthejars I've moved your chapter recommendations over to the Docs wiki in preparation for this issue being closed once the pull requests are reviewed.
Thank you for your input about the documentation and for pulling together the information sources regarding the docinfo files. ✨
from asciidoctor.org.
A pleasure to help you.
from asciidoctor.org.
Related Issues (20)
- Redirect https://asciidoctor.org/docs/asciidoctor-epub3/ to https://docs.asciidoctor.org/epub3-converter/latest/
- Maven documentation does not include how to set the snippets directory. HOT 1
- Redirect /docs/asciidoctor-diagram/ to documentation site
- Broken link to the asciidoctor-pdf docs HOT 1
- Can't find 'collapsible' documentation on docs.asciidoctor.org HOT 2
- Document zulip chat site / preserve discuss history HOT 6
- Update DNS for discuss.asciidoctor.org HOT 2
- Stop leading people into a potential trap at awestruct.org HOT 1
- Self-host Ruby API documentation HOT 2
- docs: typo in Hard Line Breaks - paragarphs HOT 3
- Header still links to the "old docs site" HOT 1
- Redirect https://asciidoctor.org/docs/asciidoctor-pdf/ to new docs
- The cross-reference information is documented all over the place HOT 1
- creating table xrefs that leverage the autogenerated table numbers HOT 1
- What the way to expose "Last update" to current time on footer in asciidoctor ? HOT 1
- Combining cells in the table header HOT 1
- User Manual is showing 404 Page Not Found HOT 1
- Asciidoctor user manual link is broken HOT 3
- Redirect asciidoctor.org/docs/asciidoctor-revealjs to docs.asciidoctor.org/reveal.js-converter/ HOT 4
- Redirect /docs/asciidoctor.js/ to documentation site HOT 3
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 asciidoctor.org.