Docs feedback (#121)

jscheiny · Apr 7, 2019 · 35eee07 · 35eee07
1 parent 3ef69a2
commit 35eee07
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/docs/defining-quantities.md b/docs/defining-quantities.md
@@ -106,4 +106,4 @@ const Velocity = Length.over(Time);
 type Velocity<N = number> = LiftMeasure<typeof Velocity, N>;
 ```
 
-This way, we can use `Velocity` to refer to the quantity on numbers, but also use `Velocity<WrappedNumber>` to operate on `WrappedMeasure`s.
+This way, we can use `Velocity` to refer to the quantity on numbers, but also use `Velocity<WrappedNumber>` to operate on `WrappedMeasure` types.
diff --git a/docs/generic-measures.md b/docs/generic-measures.md
@@ -18,7 +18,7 @@ function wrap(value: number) {
 }
 ```
 
-Now we're going to create our own measure type that operates on `WrappedNumber`s, let's call it `WrappedMeasure`:
+Now we're going to create our own measure type that operates on `WrappedNumber` types, let's call it `WrappedMeasure`:
 
 ```ts
 import { createMeasureType, GenericMeasure, Unit } from "safe-units";
@@ -61,11 +61,11 @@ After we've defined the type of `WrappedMeasure` we now define the class itself
 
 ##  Usage
 
-The returned `WrappedMeasure` now behaves just like `Measure` does except in the domain of wrapped numbers. This means we can call `WrappedMeasure.dimension` or `WrappedMeasure.of` just as expected. It's important to note that the provided quantities and units (`Length`, `Time`, `meters`, `seconds`, etc) will need to be redefined for other measure types as these types are all specific to `number`s.
+The returned `WrappedMeasure` now behaves just like `Measure` does except in the domain of wrapped numbers. This means we can call `WrappedMeasure.dimension` or `WrappedMeasure.of` just as expected. It's important to note that the provided quantities and units (`Length`, `Time`, `meters`, `seconds`, etc) will need to be redefined for other measure types as these types are all specific to `number`.
 
 ## Static Methods
 
-By default, generic measures come with a set of static methods that can be applied to measures of all numeric types. However, certain static methods may only make sense for a given numeric type. For example the `Measure.trunc` method exists because `Math.trunc` applies to `number`s. To add static methods to a generic measure type, simple pass an object as a second argument to `createMeasureType`:
+By default, generic measures come with a set of static methods that can be applied to measures of all numeric types. However, certain static methods may only make sense for a given numeric type. For example the `Measure.trunc` method exists because `Math.trunc` applies to `number` types. To add static methods to a generic measure type, simple pass an object as a second argument to `createMeasureType`:
 
 ```ts
 declare function foo(value: WrappedNumber): WrappedNumber;

diff --git a/docs/index.md b/docs/index.md
@@ -21,8 +21,8 @@ const error: Velocity = length.times(time);
 
 Safe units is written in TypeScript and should be consumed by TypeScript users to take full advantage of what it provides. In addition you will need the following:
 
-- TypeScript 2.9 or later
-- Strict null checks enabled for your project
+- [TypeScript](http://www.typescriptlang.org/) 2.9 or later
+- [Strict null checks](https://www.typescriptlang.org/docs/handbook/compiler-options.html) enabled for your project
 
 ## Installation
 

diff --git a/docsgen/markdown.tsx b/docsgen/markdown.tsx
@@ -146,10 +146,11 @@ const CodeInline = component("code-line", "code", {
 });
 
 export const Link = component("link", "a", {
-    color: "#00B3A4",
+    color: "#BF8C0A",
     textDecoration: "none",
     $nest: {
         "&:hover": {
+            color: "#A67908",
             textDecoration: "underline",
         },
     },