# o-techdocs

**Repository Path**: mirrors_Financial-Times/o-techdocs

## Basic Information

- **Project Name**: o-techdocs
- **Description**: Deprecated. We recommend o-layout with o-header-services instead.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Tech docs framework  [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](#licence)

_Deprecated. We recommend [o-layout](https://registry.origami.ft.com/components/o-layout) with [o-header-services](https://registry.origami.ft.com/components/o-layout) instead._

Documentation styles for technical documentation, API references and internal tools.

It is used in the [Origami registry](http://registry.origami.ft.com), the [image service](http://image.webservices.ft.com/v1/) and the [Origami website](http://origami.ft.com) itself.

## Styles

__o-techdocs__ has no silent mode, so the provided CSS classes beginning with `o-techdocs` must be used. See the demo page for examples.

## Header

The `o-techdocs` now uses the o-header-services header. The markup for the header can be found in the techdocs demo, for complete documentation, see http://registry.origami.ft.com/components/o-header-services.

### Migrating from v6.x.x to v7.x.x

V7 introduces a dependency on `o-header-services` and removes a dependency on `o-hierachical-nav`. You should use the `o-header-services` markup to get the header styles that you need (including navigation).
V7 introduces a dependency on `o-typography` which might cause build errors if you're also using older versions of `o-typography` elsewhere.
V7 bumps `o-colors` to the new major version. Some of the colors in `o-tech-docs` have changes slightly.
V7 removes some code deprecated in a previous version.

### Upgrading from v5.x.x to v6.x.x

v6 of `o-techdocs` removes a dependency on `o-header` v4. To upgrade, you'll need to do a find-replace on instances of `o-header` for `o-techdocs-header`.

In moving `o-header` back into `o-techdocs-header` it's possible that we've failed to migrate some features across. If, after updating to v6 and renaming `o-header` to `o-techdocs-header`, you find that things aren't working, please raise an issue.

### Upgrading from v4.x.x to v5.x.x

o-techdocs v5 relies on o-header v4 and o-grid v4.

```diff
+<div class="o-techdocs-container">
 	<div class="o-techdocs-layout">

 	</div> <!-- /.o-techdocs-layout -->
+</div> <!-- /.o-techdocs-container -->

 <footer class="o-techdocs-footer">
-	<div class="o-techdocs-footer__inner">
 		<p class="o-techdocs-footer__secondary"><a href="http://github.com/financial-times/ft-origami">View project on GitHub</a></p>
 		<p>&copy; THE FINANCIAL TIMES LTD. FT and 'Financial Times' are trademarks of The Financial Times Ltd.</p>
-	</div>
 </footer>
```