Profile cover photo
Profile photo
Maxime Gréau
173 followers
173 followers
About
Maxime Gréau's posts

Post has attachment
Devoxx France 2015 - Quelques photos !

Post has shared content

Post has attachment

Post has shared content

Post has shared content

Post has shared content
I was asked to explain how to read and edit .adoc (AsciiDoc) files for someone unfamiliar with AsciiDoc. Here's what I wrote.

I've prepared essential information about how to read and edit local AsciiDoc (.adoc) files. I also included information about the value of AsciiDoc.

What is AsciiDoc?

AsciiDoc (http://asciidoctor.org) is writing system similar to Markdown, except it's more consistent and has broader support for structured content. AsciiDoc encourages proper separation of content and presentation, enables content to be easily reused and supports publishing in a variety of layouts and formats.

About .adoc files

Like Markdown, you open an AsciiDoc file using any text editor (as opposed to a word processor). Fortunately, there are tools available that make this even easier.

Reading AsciiDoc files

If you want to preview AsciiDoc files in "reading mode", I highly recommend installing and using the AsciiDoc Preview extension for Google Chrome.

* Asciidoctor.js Live Preview extension: https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia?hl=en

Just browse to the AsciiDoc file in your web browser and you'll be able to view the content as a web page. This extension works for any AsciiDoc file accessible via the web browser. No other tools required.

Editing local AsciiDoc files

If you want to edit local AsciiDoc files, with an optional preview pane, I highly recommend installing and using the AsciiDoc Preview extension for the Brackets text editor:

 * Brackets text editor - http://brackets.io

 * AsciiDoc Preview extension - https://github.com/asciidoctor/brackets-asciidoc-preview/blob/master/README.adoc

or the Atom text editor:

* Atom text editor - http://atom.io

* AsciiDoc Preview extension - https://github.com/asciidoctor/atom-asciidoc-preview/blob/master/README.md

The links provided should include the necessary guidance to setup these tools.

Keep in mind that you can also edit AsciiDoc files directly on GitHub using the web-based editor. Just navigate to the file in the repository, click the pencil icon, modify the content and click the "Commit changes" button.

Once you get into AsciiDoc files, you'll definitely want to keep this cheat sheet for the AsciiDoc syntax handy:

* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/

Sharing AsciiDoc files with others

GitHub shows a preview of AsciiDoc content directly on the website when you navigate to the file in the repository. However, the styling leaves a bit to be desired. You can share a much more polished preview with others using docgist (http://gist.asciidoctor.org). You can think of docgist as a web-based previewer of AsciiDoc files. Here's an example:

 * http://gist.asciidoctor.org/?github-asciidoctor%2Fbrackets-asciidoc-preview%2F%2FREADME.adoc

Paste a link to any file on GitHub or in Dropbox and the application will show a preview intended for reading.

NOTE: We're still working on tools for interactive, collaborative editing of AsciiDoc files just like Google Docs. Those tools should be ready in a few months.

Why using AsciiDoc is smart business

I feel strongly that using AsciiDoc from the start is smart business. Content is maintained in a portable, reusable format and fits well with the existing collaboration workflow (the content is stored in version control, just like source code).

AsciiDoc has been selected by several very prominent teams in the last few years, most notably Pivotal (Spring, Groovy), RedHat (OpenShift, JBoss) and the Git project. I've selected a few articles that explain why these, and other teams, believe that selecting AsciiDoc puts them on a course towards better content.

* Overview of OpenShift's new documentation system - https://blog.openshift.com/new-platform-new-docs-part/

* Spring's Guides migrated to Asciidoctor - http://spring.io/blog/2013/12/13/spring-s-getting-started-guides-migrated-to-asciidoctor

* Scaling Asana.com - https://eng.asana.com/2014/02/scaling-asana-com/ (the focus is on Markdown, but applies equally well to AsciiDoc)

* (video) Behind the scenes of the new Groovy website - https://skillsmatter.com/skillscasts/6072-behind-the-scenes-the-new-groovy-website

* (in-depth article) Living the future of technical writing - https://medium.com/@chacon/living-the-future-of-technical-writing-2f368bd0a272

Note that AsciiDoc and static site generators tend to go hand in hand (as detailed in the "Scaling Asana.com" article). I strongly recommend using a static site generator to publish the website rather than a CMS.

More information about AsciiDoc

If you're interested in more details about AsciiDoc, I recommend scanning http://asciidoctor.org/docs/asciidoc-writers-guide/#writing-in-asciidoc.

Post has shared content

Post has attachment

Post has shared content
"We can address the scalability issue of WebSocket by using HTTP/2.0 framing's multiplexing functionality." -- yes! 

WebSocket over HTTP/2 (latest draft): http://bit.ly/1ka4pwd 

Post has shared content
+David Gageot sera speaker au #devfest   #nantes  le 07/11 

Au passage, le #cfp  est ouvert jusqu'au 15/09 !
Wait while more posts are being loaded