Services / Antora

Antora and Docusaurus Documentation Sites

I build, migrate and maintain documentation sites using static site generators, and can analyse which is the best fit for your documentation needs.

Simplify your documentation site: websites built from static files, generated from AsciiDoc or Markdown. Creates a fast-loading static site with no need to upgrade or patch the build process.

Can create more dynamic features for your sites, such as including Lunr search engines in your Antora-built site.

The Process

  • Establish structure of documentation required. Choose tool based on information here.
  • Build initial structure based on this decision. For example, writing your Antora playbook for build, or coding your Docusaurus config.
  • Develop a UI bundle themed to your product, giving it your unique spin.
  • Implement the correct search and navigation tools.
  • Write the CI/CD publishing pipeline, to create the self-generating site.
  • Write AsciiDoc conventions and templates for engineers and maintainers after the project is finished.
  • This process creates an accessible and responsive site. No bells or whistles needed.
  • Fit the pipeline into your existing web hosting system. This process is also automated in the CI/CD pipeline.
  • After I'm done, you will have a build system which any dev or engineer can run themselves.

A Cohesive Docs-as-Code Site

No matter the tool, the result is a clear, navigable website. The Landing Page and Content will be wrapped in a UI that fits your brand design.

Related: Docs-as-code CI/CD pipelines · Confluence to AsciiDoc migration

Want to discuss an Antora project? Contact me here!

Email All services