![]() Often I work on documents that include standardized text or content (e.g., information about licensing, support, or company descriptions). When the article is ready to publish, I merge it back into my master branch. Once I give my article a couple of edits to make sure everything flows well, I add AsciiDoc markup so Hugo can format the article as clean HTML. ![]() I use a new branch in Git for each article, which keeps things nice and simple until I am ready to publish. I normally write my first drafts in plain English. on very little sleep and too much coffee Documentation workflow "My blog post is done! And now to send my masterpiece to the world! … Wait a minute, why is all my text a H1? I hate myself." By running Hugo in a console, I can see issues with my document whenever I save it, so I can fix them and move on. AsciiDoc helps me write documents with a nice structure, and Hugo uses AsciiDoctor to convert the documents into other formats, such as PDF or Linux man pages, as I write them. Because I can preview them locally as HTML, I can identify places my content needs work. Hugo has a decent template system, so I can do a lot more with a lot less code. Using the Hugo platform with the AsciiDoc markup language and AsciiDoctor, a digital Swiss Army knife for AsciiDoc, helps me focus on content and structure rather than presentation. Then I tweak it a little more, then a weekend is gone, and I haven't written any content. I spent all my time playing with the theme or working on back-end services. This is a fine idea, but, in reality, I constantly tweak the site. When I develop a blog, I start with the idea of "content first" and try not to get tied up with the platform. Other interactive elements, such as comments, can be added with Disqus. If you combine it with a Git branching strategy, multiple authors can work on blogs and articles, then book them back into your main branch when ready to publish. Everyone on your team can run a copy of the site locally, so they can work on their articles in a draft state and refrain from publishing them until they're ready. ![]() It supports tasks that normally are driven by a blogging platform for example, it can automatically populate an RSS feed when a new article is added. It also makes a website faster than one on a traditional platform, and combining it with a content-delivery network (CDN) produces a very fast website. The lack of a database or need for a language such as PHP reduce the risk of SQL injection, making it especially handy for creating secure sites. As long as your server can deliver HTML, you're good to go. It even comes with its own server, so I can test my site while I work on it. The pages are rendered in HTML, so sites are blazingly fast and very easy to maintain. One big advantage to me is that Hugo doesn't require a database to support a blog site with plenty of functionality. It is a very feature-rich platform, with a rich language for working with templates and theming, and it's a lot of fun to work with. This got me thinking, "Wouldn't it be handy to be able to maintain a website purely with AsciiDoc?"Īfter some googling and chatting with colleagues, I found Hugo, a publishing platform that can transform articles written in Markdown or AsciiDoc into usable content for the web. AsciiDoc allows you to write documentation in a more natural way and mark it up cleanly for presentation on the web or as a PDF. It has a simple syntax, but enough features to keep even a hardcore documentation nerd happy. I work daily with content management tools and support documentation writers whose preferred markup language is AsciiDoc. If you suggest us any shortcut request, we can implement it. AFX supports this ace shortcuts and custom shortcuts listed below. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |