Writing docs in your IDE - an AsciiDoc primer

Channel:
Eclipse Foundation
Subscribers:
24,000
Published on ● Video Link: https://www.youtube.com/watch?v=DsOjiZL3UOE


Duration: 27:58
3,321 views
23

Follow the documentation-as-code approach: Write documentation in your IDE, collaborate with other developers and writers using version control and let a continuous integration server scrutinize and publish your docs.

AsciiDoc is a lightweight markup language that translates for example to HTML and PDF. In your development environment, an IDE plugin provides editor support and preview pane. Every commit to your version control system not only enhances your program, but also your architecture, developer or user documentation.

After a short introduction to AsciiDoc this talk shows how to edit and structure content in a development environment. Live examples show how to work with the AsciiDoc in the IDE and the build process.

Participants can use a URL to try out small AsciiDoc examples in their local browsers during the talk. Of the 30 minutes total talk time at the EclipseCon I plan to use 15 minutes for an interactive Q&A.

This session is independent of the programming language people use their projects as documentation is a universal topic in all projects. Users will see how information can be captured in AsciiDoc and can compare it to other markup languages, wikis or office formats.

Speaker(s):
Alexander Schwartz (msg systems ag)



Other Videos By Eclipse Foundation


2020-10-26A harmonized open source platform for effectiveness assessment in the field of automated driving
2020-10-26Web-based modeling tools with EMF.cloud
2020-10-26Deploying a Modern Serverless Container as powered by Vert.x
2020-10-26A simple code generator for bespoke data models, web forms, and scientific workflows in Eclipse ICE
2020-10-26What Edge Computing Can Learn From the Moon Landings
2020-10-26Sustainability in Software Engineering
2020-10-26Easier integration testing in OSGi: The open source osgi-test project
2020-10-26Wellness Break: Mindfulness for Developers (Part 2)
2020-10-26Run your APPs on carrier edge: an open source solution
2020-10-26Ecore tools in the cloud - behind the scenes
2020-10-26Writing docs in your IDE - an AsciiDoc primer
2020-10-26Make your microservices as much robust as mission critical systems by MicroProfile and Jakarta EE
2020-10-26Building an Industrial IoT Solution - Open Source
2020-10-26From non-modular to modular Java programs - What you need to know
2020-10-26Beyond LSP: Getting Your Language into Theia and VS Code
2020-10-26Building a Language Server for Eclipse MicroProfile
2020-10-26Walking through the Eclipse IDE tooling support for new Java versions
2020-10-26It's Easy! Contributing to Open Source in Java
2020-10-25Deploy your Java applications to the Cloud using Eclipse JKube
2020-10-25Jakarta NoSQL: One API to many NoSQL databases into Cloud Native age
2020-10-25Using the Power of the LSP to Create Unconventional Language-Client/Server Integrations


Tags:
Eclipsecon 2020
AsciiDoc
documentation as code
markup language