-resource-path : Some context for Pandoc to help it to find the medias attached to the book (the images).In my workflow, I produce the book with the following command : Pandoc is a command line tool that takes the input files as parameters and the expected output with some settings. For the anecdote, MacFarlane was among the people who launched the CommonMark initiative. I needed this tool to convert the markdown files into the epub book. It’s a very clever tool since you don’t really have to tell it the input format and you just need to specify the output. It can convert files from a markup language to another. Pandoc is a universal document converter created by John MacFarlane. On its side, Ghostwriter is single file (you edit one file at time and can open several instances), but it is able to export the content with various documents converters, such as Pandoc. Why two editors ? Actually, Zettlr is great for its project management aspect using workspaces with files and a navigator, for my blog it’s perfect. In my case, I use Zettlr to write on this blog, and the book Linux Explained was reshaped with Ghostwriter, both Markdown text editors. Markdown also became a pretty common writing language for note takings with several text editor using it for text formatting with online preview (in the text, or in a separated area), dynamic screenshot insertion, etc. BitBucket, Diaspora, OpenstreetMap, Reddit, etc, use their own variants. For example, GitHub maintains its “GitHub-flavored Markdown” version since 2009. However, there are still some custom implementations, or flavors, maintained by several actors. Almost because initially, Markdown was a specification with ambiguous parts and its implementations diverged until the standard CommonMark got established, unambiguous this time. ( Markdown has, in my opinion, two big advantages : it’s very simple to write and read, and nowadays pretty common and almost standardized. *Some text in italic*, **some text in bold** | A | table | With | columns | This blog articles are written using this markup language actually. It uses a very simple syntax to format a text using headlines, links, references, text styling, and so on. Markdown is a markup language created in 2004 by John Gruber and Aaron Swartz designed to be lightweight and human readable. And if you add a second “D” to CI/CD:D you will add the “Deployment” step to the continuity.įor a book, the code is the text, the “programming” language is Markdown in my case, the “compiler” is Pandoc, and the artifact is an EPUB e-book. A traditional CI/CD pipeline is a workflow that will checkout code from a source code repository, compile it using the language-related compiler or packager, use Quality Gates to ensure the quality of the product, produce an artifact, and publish it on a shelf for further installation. So I’ve tried to figure out by myself how to achieve that. The idea was germinating in my head while writing the articles and I was wondering if I could maintaining the text using the CI/CD patterns.Īctually again, it’s not a revolution, a lot of documentations and writings are maintained in the same way. Recently, I’ve compiled the Linux Explained articles into an e-book. This may sound a little incongruous if for you the Continous Integration / Continuous Delivery patterns are for software development, but yes, you can maintain a book with the same principles.
0 Comments
Leave a Reply. |